@acceleratxr/core_sdk / LeaderboardService
Class: LeaderboardService#
Hierarchy#
-
↳ LeaderboardService
Index#
Constructors#
Properties#
Methods#
Constructors#
constructor#
+ new LeaderboardService(apiClient: ApiClient, config: Configuration): LeaderboardService
Overrides ServiceBase.constructor
Defined in src/services/LeaderboardService.ts:11
Parameters:#
Name |
Type |
|---|---|
|
|
|
Returns: LeaderboardService
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 = “89066296-8b80-4386-a96a-d9efb47cad2a”
Defined in src/services/LeaderboardService.ts:17
Methods#
count#
▸ count(query?: any): Promise<number>
Defined in src/services/LeaderboardService.ts:58
Returns the count of leaderboard definitions based on the given criteria.
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<number>
create#
▸ create(obj: Leaderboard): Promise<Leaderboard | undefined>
Defined in src/services/LeaderboardService.ts:34
Creates a new leaderboard definition.
Parameters:#
Name |
Type |
|---|---|
|
Returns: Promise<Leaderboard | undefined>
delete#
▸ delete(id: string): Promise<void>
Defined in src/services/LeaderboardService.ts:103
Deletes the leaderboard from the service.
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<void>
findAll#
▸ findAll(query?: any): Promise<Leaderboard[] | undefined>
Defined in src/services/LeaderboardService.ts:22
Returns all leaderboard definitions from the system that the user has access to based upon the given criteria.
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<Leaderboard[] | undefined>
findById#
▸ findById(id: string): Promise<Leaderboard | undefined>
Defined in src/services/LeaderboardService.ts:77
Returns a single leaderboard definition from the system that the user has access to.
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<Leaderboard | undefined>
truncate#
▸ truncate(query?: any): Promise<void>
Defined in src/services/LeaderboardService.ts:46
Deletes all leaderboard definitions from the service.
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<void>
update#
▸ update(id: string, obj: Leaderboard): Promise<Leaderboard | undefined>
Defined in src/services/LeaderboardService.ts:90
Updates a single leaderboard definition.
Parameters:#
Name |
Type |
|---|---|
|
string |
|
Returns: Promise<Leaderboard | undefined>