@acceleratxr/core_sdk / SkillService

Class: SkillService#

Hierarchy#

Index#

Constructors#

Properties#

Methods#

Constructors#

constructor#

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

Overrides ServiceBase.constructor

Defined in src/services/SkillService.ts:15

Parameters:#

Name

Type

apiClient

ApiClient

config

Configuration

Returns: SkillService

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 = “2d6bb85f-38bd-4429-84cd-149b3101d6c2”

Defined in src/services/SkillService.ts:21

Methods#

count#

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

Defined in src/services/SkillService.ts:106

Returns the count of skills that a persona has in progress or has completed.

Parameters:#

Name

Type

personaUid?

undefined | string

query?

any

Returns: Promise<number>


countByArchetype#

countByArchetype(personaUid: string, archetypeUid: string, query?: any): Promise<number>

Defined in src/services/SkillService.ts:43

Returns the count of skills that a persona and archetype has in progress or has completed.

Parameters:#

Name

Type

personaUid

string

archetypeUid

string

query?

any

Returns: Promise<number>


findAll#

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

Defined in src/services/SkillService.ts:124

Returns progress data for all skills that the given persona has started or completed.

Parameters:#

Name

Type

personaUid?

undefined | string

query?

any

Returns: Promise<Skill[] | undefined>


findAllByArchetype#

findAllByArchetype(personaUid: string, archetypeUid: string, query?: any): Promise<Skill[] | undefined>

Defined in src/services/SkillService.ts:61

Returns progress data for all skills that the given persona and archetype has started or completed.

Parameters:#

Name

Type

personaUid

string

archetypeUid

string

query?

any

Returns: Promise<Skill[] | undefined>


findById#

findById(skillUid: string, personaUid?: undefined | string, query?: any): Promise<Skill | undefined>

Defined in src/services/SkillService.ts:136

Returns the progress for a given skill and persona and archetype.

Parameters:#

Name

Type

skillUid

string

personaUid?

undefined | string

query?

any

Returns: Promise<Skill | undefined>


findByIdAndArchetype#

findByIdAndArchetype(skillUid: string, personaUid: string, archetypeUid: string, query?: any): Promise<Skill | undefined>

Defined in src/services/SkillService.ts:89

Returns the progress for a given skill and persona and archetype.

Parameters:#

Name

Type

skillUid

string

personaUid

string

archetypeUid

string

query?

any

Returns: Promise<Skill | undefined>


findByIdAndProduct#

findByIdAndProduct(skillUid: string, personaUid: string, productUid: string, query?: any): Promise<Skill | undefined>

Defined in src/services/SkillService.ts:152

Returns the progress for a given skill and persona and archetype.

Parameters:#

Name

Type

skillUid

string

personaUid

string

productUid

string

query?

any

Returns: Promise<Skill | undefined>


getURL#

PrivategetURL(personaUid?: undefined | string, archetypeUid?: undefined | string): string

Defined in src/services/SkillService.ts:23

Parameters:#

Name

Type

personaUid?

undefined | string

archetypeUid?

undefined | string

Returns: string


truncateByArchetype#

truncateByArchetype(personaUid: string, archetypeUid: string, query?: any): Promise<void>

Defined in src/services/SkillService.ts:77

Resets all the persona’s skill progress for the given archetype.

Parameters:#

Name

Type

personaUid

string

archetypeUid

string

query?

any

Returns: Promise<void>