@acceleratxr/core_sdk / ArchetypeService

Class: ArchetypeService

Hierarchy

• ServiceBase

  ↳ ArchetypeService

Index

Constructors

• constructor

Properties

• apiClient

• config

• uuid

Methods

• count

• deactivate

• deactivateAll

• findAll

• findById

• toggle

Constructors

constructor

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

Overrides ServiceBase.constructor

Defined in src/services/ArchetypeService.ts:12

Parameters:

Name	Type
apiClient	ApiClient
config	Configuration

Returns: ArchetypeService

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 = “e8e0f72b-bb27-4b54-a5dc-2077681fa3bf”

Defined in src/services/ArchetypeService.ts:18

Methods

count

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

Defined in src/services/ArchetypeService.ts:49

Returns the count of archetypes that a persona has activate.

Parameters:

Name	Type
personaUid	string
query?	any

Returns: Promise<number>

---

deactivate

▸ deactivate(personaUid: string, archetypeUid: string): Promise<void>

Defined in src/services/ArchetypeService.ts:87

Stops tracking all progress for the given archetype and persona.

Parameters:

Name	Type
personaUid	string
archetypeUid	string

Returns: Promise<void>

---

deactivateAll

▸ deactivateAll(personaUid: string): Promise<void>

Defined in src/services/ArchetypeService.ts:36

Stops tracking all progress for all archetypes and persona.

Parameters:

Name	Type
personaUid	string

Returns: Promise<void>

---

findAll

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

Defined in src/services/ArchetypeService.ts:23

Returns all archetypes that the given persona has activated.

Parameters:

Name	Type
personaUid	string
query?	any

Returns: Promise<ArchetypeDefinition[] | undefined>

---

findById

▸ findById(personaUid: string, archetypeUid: string, query?: any): Promise<ArchetypeDefinition | undefined>

Defined in src/services/ArchetypeService.ts:69

Returns the archetype definition.

Parameters:

Name	Type
personaUid	string
archetypeUid	string
query?	any

Returns: Promise<ArchetypeDefinition | undefined>

---

toggle

▸ toggle(personaUid: string, archetypeUid: string, obj: ArchetypeActivation): Promise<void>

Defined in src/services/ArchetypeService.ts:101

Toggles the activation state of all skill progress for a given archetype and persona.

Parameters:

Name	Type
personaUid	string
archetypeUid	string
obj	ArchetypeActivation

Returns: Promise<void>