UserAchievements In-Process API Service

Ben Tiedt — Fri, 15 Jan 2021 20:00:22 GMT

Current Revision posted to API Documentation by Ben Tiedt on 01/15/2021 20:00:22

This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.IUserAchievements>() and is defined in Telligent.Evolution.Platform.dll

Events

Events.AfterCreate

Handler

void UserAchievementAfterCreateEventHandler([[UserAchievementAfterCreateEventArgs In-Process API Event Argument|UserAchievementAfterCreateEventArgs]] e);

Events.AfterDelete

Handler

void UserAchievementAfterDeleteEventHandler([[UserAchievementAfterDeleteEventArgs In-Process API Event Argument|UserAchievementAfterDeleteEventArgs]] e);

Events.BeforeCreate

Handler

void UserAchievementBeforeCreateEventHandler([[UserAchievementBeforeCreateEventArgs In-Process API Event Argument|UserAchievementBeforeCreateEventArgs]] e);

Events.BeforeDelete

Handler

void UserAchievementBeforeDeleteEventHandler([[UserAchievementBeforeDeleteEventArgs In-Process API Event Argument|UserAchievementBeforeDeleteEventArgs]] e);

Properties

Name	Type	Description	Default	Options
DataTypeId	`Guid`

Methods

UserAchievement Create(int userId, Guid achievementId);

Award an achievement to a user

Parameters

Name	Type	Description	Required	Default	Options
userId	`int`	User Id	Required
achievementId	`Guid`	Achievement Id	Required

Return Type

[[UserAchievement In-Process API Supplementary Type|UserAchievement]]

AdditionalInfo Delete(int userId, Guid achievementId);

Remove an achievement from a user

Parameters

Name	Type	Description	Required	Default	Options
userId	`int`	User Id	Required
achievementId	`Guid`	Achievement Id	Required

Return Type

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]

UserAchievement Get(int userId, Guid achievementId);

Award an achievement to a user

Parameters

Name	Type	Description	Required	Default	Options
userId	`int`	User Id	Required
achievementId	`Guid`	Achievement Id	Required

Return Type

[[UserAchievement In-Process API Supplementary Type|UserAchievement]]

PagedList<UserAchievement> List(UserAchievementListOptions options = null);

List achievements earned by a user

Parameters

Name	Type	Description	Required	Default	Options
options	`[[UserAchievementListOptions In-Process API Supplementary Type\|UserAchievementListOptions]]`	Options include:UserId,AchievementId, Enabled, CreatedBeforeDate, CreatedAfterDate, SortBy (Title, DateCreated), SortOrder (Ascending, Descending), PageSize, PageIndex	Optional

Return Type

[[PagedList(T) In-Process API Supplementary Type|PagedList]]<[[UserAchievement In-Process API Supplementary Type|UserAchievement]]>