This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.IAchievements>() and is defined in Telligent.Evolution.Platform.dll
Events
Events.AfterCreate
Handler
void AchievementAfterCreateEventHandler(AchievementAfterCreateEventArgs e);
Events.AfterDelete
Handler
void AchievementAfterDeleteEventHandler(AchievementAfterDeleteEventArgs e);
Events.AfterUpdate
Handler
void AchievementAfterUpdateEventHandler(AchievementAfterUpdateEventArgs e);
Events.BeforeCreate
Handler
void AchievementBeforeCreateEventHandler(AchievementBeforeCreateEventArgs e);
Events.BeforeDelete
Handler
void AchievementBeforeDeleteEventHandler(AchievementBeforeDeleteEventArgs e);
Events.BeforeUpdate
Handler
void AchievementBeforeUpdateEventHandler(AchievementBeforeUpdateEventArgs e);
Methods
Achievement Create(string title, string criteria, string badgeIconName, Byte[] badgeIconData, AchievementCreateOptions options = null);
Create an achievement. OBSOLETE in 12: Use Create overload that takes BadeIconUploadContext instead.
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| title | string | Title | Required | ||
| criteria | string | Criteria | Required | ||
| badgeIconName | string | Badge Icon Name | Required | ||
| badgeIconData | Byte[] | Badge Icon Data | Required | ||
| options | AchievementCreateOptions | Options | Optional |
Return Type
Achievement Create(string title, string criteria, string badgeIconName, Stream badgeIconStream, AchievementCreateOptions options = null);
Create an achievement. OBSOLETE in 12: Use Create overload that takes BadeIconUploadContext instead.
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| title | string | Title | Required | ||
| criteria | string | Criteria | Required | ||
| badgeIconName | string | Badge Icon Name | Required | ||
| badgeIconStream | Stream | Badge Icon Stream | Required | ||
| options | AchievementCreateOptions | Options | Optional |
Return Type
Achievement Create(string title, string criteria, string badgeIconName, string badgeIconUploadContext, AchievementCreateOptions options = null);
Create an achievement
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| title | string | Title | Required | ||
| criteria | string | Criteria | Required | ||
| badgeIconName | string | Badge Icon Name | Required | ||
| badgeIconUploadContext | string | Badge Icon Upload Context | Required | ||
| options | AchievementCreateOptions | Options | Optional |
Return Type
AdditionalInfo Delete(Guid achievementId);
Delete achievement by its Id
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| achievementId | Guid | Achievement Id | Required |
Return Type
Achievement Get(Guid achievementId);
Gets an achievement by its Id
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| achievementId | Guid | Achievement Id | Required |
Return Type
PagedList<Achievement> List(AchievementListOptions options = null);
List achievements
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| options | AchievementListOptions | Options include: Enabled, SortBy (Title, DateCreated), SortOrder (Ascending, Descending), PageSize, PageIndex | Optional |
Return Type
Achievement Update(Guid id, AchievementUpdateOptions options);
Update an achievement
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| id | Guid | Id | Required | ||
| options | AchievementUpdateOptions | Options | Required |