Class QuestService#

Inheritance Relationships#

Base Type#

Class Documentation#

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

Public Functions

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

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

Param personaUid:

PersonID related to this task

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.

Task<Quest> Create (Guid personaUid, Quest obj)#

Starts progress of the given quest for the specified persona.

Param personaUid:

PersonID related to this

Param obj:

The object to persist with the remote service.

Return:

A task whose result is the final object as it was persisted with the remote service.

Task Truncate (Guid personaUid)#

Deletes all the persona’s quest progress.

Param personaUid:

PersonID related to this

Return:

A task.

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

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

Param personaUid:

PersonID related to this

Param query:

Return:

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

Task<Quest> FindById (Guid personUid, Guid questUid)#

Returns the progress for a given quest and persona.

Param personUid:

PersonID related to this

Param questUid:

questUid The id value which uniquely identifies the object.

Return:

<A task whose result is the object with the specified identifier if found./returns>

Task<Quest> Start (Guid personUid, Guid questUid)#

Starts tracking the persona’s progress for a given quest.

Param personUid:

PersonID related to this

Param questUid:

questUid The id value which uniquely identifies the object.

Return:

A task.

Task<Quest> Unlock (Guid personUid, Guid questUid)#

Deletes the persona’s progress for a given quest.

Param personUid:

PersonID related to this

Param questUid:

The id value which uniquely identifies the object.

Return:

A task.

Task Delete (Guid personUid, Guid questUid)#

Deletes the persona’s progress for a given quest.

Param personUid:

PersonID related to this

Param questUid:

The id value which uniquely identifies the object.

Return:

A task.

string GetURL (Guid id)#

Returns the compiled url path.

Param id:

The persona id to be compiled into the path

Return:

Compiled Path