Class SkillService#

Inheritance Relationships#

Base Type#

Class Documentation#

class xbe.sdk.Services.SkillService : xbe.sdk.ServiceBase#

Public Functions

SkillService ()#
Task<List<Skill>> FindAllByArchetype (Guid personaUid, Guid archetypeUid, Dictionary<string, string> query = null)#

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

Param personaUid:

The id value which uniquely identifies the persona.

Param archetypeUid:

The unique identifier of the archetype.

Param query:

A map of property names to values to search for.

Return:

A task whose result is a list of objects matching the specified search parameters.

async Task<long> CountByArchetype (Guid personaUid, Guid archetypeUid, Dictionary<string, string> query = null)#

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

Param personaUid:

The id value which uniquely identifies the persona.

Param archetypeUid:

The unique identifier of the archetype.

Param query:

A map of property names to values to search for.

Return:

A task whose result is the number of objects matching the specified search parameters.

Task TruncateByArchetype (Guid personaUid, Guid archetypeUid)#

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

Param personaUid:

The id value which uniquely identifies the persona.

Param archetypeUid:

The unique identifier of the archetype.

Return:

A task.

Task<Skill> FindById (Guid personaUid, Guid archetypeUid, Guid skillUid)#

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

Param personaUid:

The id value which uniquely identifies the persona.

Param archetypeUid:

The unique identifier of the archetype.

Param skillUid:

Return:

A task whose result is the object with the specified identifier if found.

Task Delete (Guid personaUid, Guid archetypeUid, Guid skillUid)#

Deletes the persona’s progress for a given skill and archetype.

Param personaUid:

The id value which uniquely identifies the persona.

Param archetypeUid:

The unique identifier of the archetype.

Param skillUid:

Return:

A task.

Task AddProgress (Guid personaUid, Guid archetypeUid, Guid skillUid, SkillRequirementProgress progress)#

Adds the given progress data to the specified skill.

Param personaUid:

The id value which uniquely identifies the persona.

Param archetypeUid:

The unique identifier of the archetype.

Param progress:

Progress add for skill

Return:

A task.

Task<List<Skill>> FindAll (Guid personaUid, Dictionary<string, string> query = null)#

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

Param personaUid:

The id value which uniquely identifies the persona.

Param query:

A map of property names to values to search for.

Return:

A task whose result is a list of objects matching the specified search parameters.

async Task<long> Count (Guid personaUid, Dictionary<string, string> query = null)#

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

Param personaUid:

The id value which uniquely identifies the persona.

Param query:

A map of property names to values to search for.

Return:

A task whose result is the number of objects matching the specified search parameters.

string ArchetypePath (Guid personaUid, Guid archetypeUid)#

Returns the compiled url path.

Param personaUid:

The persona id to be compiled into the path

Param archetypeUid:

The archetype id to be compiled into the path

Return:

Compiled Path

string GetURL (Guid personaUid)#

Returns the compiled url path.

Param personaUid:

The persona id to be compiled into the path

Return:

Compiled Path