@acceleratxr/core_sdk / QuestService
Class: QuestService#
Hierarchy#
-
↳ QuestService
Index#
Constructors#
Properties#
Methods#
Constructors#
constructor#
+ new QuestService(apiClient: ApiClient, config: Configuration): QuestService
Overrides ServiceBase.constructor
Defined in src/services/QuestService.ts:11
Parameters:#
Name |
Type |
|---|---|
|
|
|
Returns: QuestService
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 = “7304d6bb-472a-42c9-9e93-f3b48f9792e5”
Defined in src/services/QuestService.ts:17
Methods#
adminCount#
▸ adminCount(query?: any): Promise<number>
Defined in src/services/QuestService.ts:35
Returns the count of quests that a persona has in progress or has completed.
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<number>
adminFindAll#
▸ adminFindAll(query?: any): Promise<Quest[] | undefined>
Defined in src/services/QuestService.ts:22
Returns progress data for all quests for all users.
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<Quest[] | undefined>
count#
▸ count(personaUid: string, query?: any): Promise<number>
Defined in src/services/QuestService.ts:94
Returns the count of quests that a persona has in progress or has completed.
Parameters:#
Name |
Type |
|---|---|
|
string |
|
any |
Returns: Promise<number>
create#
▸ create(personaUid: string, obj: Quest): Promise<Quest | undefined>
Defined in src/services/QuestService.ts:68
Starts progress of the given quest for the specified persona.
Parameters:#
Name |
Type |
|---|---|
|
string |
|
Returns: Promise<Quest | undefined>
delete#
▸ delete(personaUid: string, questUid: string): Promise<void>
Defined in src/services/QuestService.ts:132
Deletes the persona’s progress for a given quest.
Parameters:#
Name |
Type |
|---|---|
|
string |
|
string |
Returns: Promise<void>
findAll#
▸ findAll(personaUid: string, query?: any): Promise<Quest[] | undefined>
Defined in src/services/QuestService.ts:55
Returns progress data for all quests that the given persona has started or completed.
Parameters:#
Name |
Type |
|---|---|
|
string |
|
any |
Returns: Promise<Quest[] | undefined>
findById#
▸ findById(personaUid: string, questUid: string, query?: any): Promise<Quest | undefined>
Defined in src/services/QuestService.ts:114
Returns the progress for a given quest and persona.
Parameters:#
Name |
Type |
|---|---|
|
string |
|
string |
|
any |
Returns: Promise<Quest | undefined>
start#
▸ start(personaUid: string, questUid: string): Promise<Quest | undefined>
Defined in src/services/QuestService.ts:146
Starts tracking the persona’s progress for a given quest.
Parameters:#
Name |
Type |
|---|---|
|
string |
|
string |
Returns: Promise<Quest | undefined>
truncate#
▸ truncate(personaUid: string, query?: any): Promise<void>
Defined in src/services/QuestService.ts:81
Deletes all the persona’s quest progress.
Parameters:#
Name |
Type |
|---|---|
|
string |
|
any |
Returns: Promise<void>
unlock#
▸ unlock(personaUid: string, questUid: string): Promise<Quest | undefined>
Defined in src/services/QuestService.ts:160
Marks the quest has unlocked and able to be started by the specified persona.
Parameters:#
Name |
Type |
|---|---|
|
string |
|
string |
Returns: Promise<Quest | undefined>