@acceleratxr/core_sdk / AchievementDefinitionService
Class: AchievementDefinitionService#
Hierarchy#
-
↳ AchievementDefinitionService
Index#
Constructors#
Properties#
Methods#
Constructors#
constructor#
+ new AchievementDefinitionService(apiClient: ApiClient, config: Configuration): AchievementDefinitionService
Overrides ServiceBase.constructor
Defined in src/services/AchievementDefinitionService.ts:11
Parameters:#
Name |
Type |
|---|---|
|
|
|
Returns: AchievementDefinitionService
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 = “e58c499d-b193-4fa1-9d61-c51b5e90360a”
Defined in src/services/AchievementDefinitionService.ts:17
Methods#
count#
▸ count(query?: any): Promise<number>
Defined in src/services/AchievementDefinitionService.ts:22
Returns the count of achievement definitions based on the given criteria.
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<number>
create#
▸ create(obj: AchievementDefinition): Promise<AchievementDefinition | undefined>
Defined in src/services/AchievementDefinitionService.ts:41
Creates a new achievement definition.
Parameters:#
Name |
Type |
|---|---|
|
Returns: Promise<AchievementDefinition | undefined>
delete#
▸ delete(id: string): Promise<void>
Defined in src/services/AchievementDefinitionService.ts:53
Deletes the achievement definition from the service.
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<void>
findAll#
▸ findAll(query?: any): Promise<AchievementDefinition[] | undefined>
Defined in src/services/AchievementDefinitionService.ts:66
Returns all achievement definitions from the system that the user has access to based upon the given criteria.
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<AchievementDefinition[] | undefined>
findById#
▸ findById(id: string): Promise<AchievementDefinition | undefined>
Defined in src/services/AchievementDefinitionService.ts:78
Returns a single achievement definition from the system that the user has access to.
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<AchievementDefinition | undefined>
truncate#
▸ truncate(query?: any): Promise<void>
Defined in src/services/AchievementDefinitionService.ts:104
Deletes all achievement definitions from the service.
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<void>
unlock#
▸ unlock(id: string): Promise<Achievement | undefined>
Defined in src/services/AchievementDefinitionService.ts:116
Unlocks the achievement with the given id for the authenticated user.
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<Achievement | undefined>
update#
▸ update(id: string, obj: AchievementDefinition): Promise<AchievementDefinition | undefined>
Defined in src/services/AchievementDefinitionService.ts:91
Updates a single achievement definition.
Parameters:#
Name |
Type |
|---|---|
|
string |
|
Returns: Promise<AchievementDefinition | undefined>