@acceleratxr/core_sdk / LeaderboardRecordService

Class: LeaderboardRecordService

Hierarchy

• ServiceBase

  ↳ LeaderboardRecordService

Index

Constructors

• constructor

Properties

• apiClient

• config

• uuid

Methods

• count

• create

• findAll

• truncate

Constructors

constructor

+ new LeaderboardRecordService(apiClient: ApiClient, config: Configuration): LeaderboardRecordService

Overrides ServiceBase.constructor

Defined in src/services/LeaderboardRecordService.ts:10

Parameters:

Name	Type
apiClient	ApiClient
config	Configuration

Returns: LeaderboardRecordService

Properties

apiClient

• Protected apiClient: ApiClient

Inherited from ServiceBase.apiClient

Defined in src/ServiceBase.ts:14

The API Client used when making requests to the API backend server.

---

config

• Protected config: Configuration

Inherited from ServiceBase.config

Defined in src/ServiceBase.ts:19

The SDK configuration to use.

---

uuid

▪ Static uuid: string = “e38b37b7-631d-4b0d-aed4-6c4c66f9462d”

Defined in src/services/LeaderboardRecordService.ts:16

Methods

count

▸ count(id: string, query?: any): Promise<number>

Defined in src/services/LeaderboardRecordService.ts:60

Returns the count of records in a given leaderboard based on the given criteria.

Parameters:

Name	Type
id	string
query?	any

Returns: Promise<number>

---

create

▸ create(id: string, obj: LeaderboardRecord): Promise<LeaderboardRecord | undefined>

Defined in src/services/LeaderboardRecordService.ts:34

Creates a new leaderboard record.

Parameters:

Name	Type
id	string
obj	LeaderboardRecord

Returns: Promise<LeaderboardRecord | undefined>

---

findAll

▸ findAll(id: string, query?: any): Promise<LeaderboardRecord[] | undefined>

Defined in src/services/LeaderboardRecordService.ts:21

Returns all the records for a single leaderboard from the system that the user has access to based upon the given criteria.

Parameters:

Name	Type
id	string
query?	any

Returns: Promise<LeaderboardRecord[] | undefined>

---

truncate

▸ truncate(id: string, query?: any): Promise<void>

Defined in src/services/LeaderboardRecordService.ts:47

Deletes all the leaderboard’s records from the service.

Parameters:

Name	Type
id	string
query?	any

Returns: Promise<void>