@acceleratxr/core_sdk / AchievementService
Class: AchievementService#
Hierarchy#
-
↳ AchievementService
Index#
Constructors#
Properties#
Methods#
Constructors#
constructor#
+ new AchievementService(apiClient: ApiClient, config: Configuration): AchievementService
Overrides ServiceBase.constructor
Defined in src/services/AchievementService.ts:11
Parameters:#
Name |
Type |
|---|---|
|
|
|
Returns: AchievementService
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 = “3bb51098-803a-40be-99c5-ddf136b3ac23”
Defined in src/services/AchievementService.ts:17
Methods#
count#
▸ count(userUid: string, query?: any): Promise<number>
Defined in src/services/AchievementService.ts:35
Returns the count of Achievement objects that a given user has unlocked.
Parameters:#
Name |
Type |
|---|---|
|
string |
|
any |
Returns: Promise<number>
findAll#
▸ findAll(userUid: string, query?: any): Promise<Achievement[] | undefined>
Defined in src/services/AchievementService.ts:22
Returns all achievements that the given user has unlocked.
Parameters:#
Name |
Type |
|---|---|
|
string |
|
any |
Returns: Promise<Achievement[] | undefined>
unlock#
▸ unlock(id: string): Promise<Achievement | undefined>
Defined in src/services/AchievementService.ts:55
Unlocks the achievement with the given id for the authenticated user.
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<Achievement | undefined>