Achievements In-Process API Service

Ben Tiedt — Fri, 08 Mar 2024 17:30:53 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:30:53

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 In-Process API Event Argument|AchievementAfterCreateEventArgs]] e);

Events.AfterDelete

Handler

void AchievementAfterDeleteEventHandler([[AchievementAfterDeleteEventArgs In-Process API Event Argument|AchievementAfterDeleteEventArgs]] e);

Events.AfterUpdate

Handler

void AchievementAfterUpdateEventHandler([[AchievementAfterUpdateEventArgs In-Process API Event Argument|AchievementAfterUpdateEventArgs]] e);

Events.BeforeCreate

Handler

void AchievementBeforeCreateEventHandler([[AchievementBeforeCreateEventArgs In-Process API Event Argument|AchievementBeforeCreateEventArgs]] e);

Events.BeforeDelete

Handler

void AchievementBeforeDeleteEventHandler([[AchievementBeforeDeleteEventArgs In-Process API Event Argument|AchievementBeforeDeleteEventArgs]] e);

Events.BeforeUpdate

Handler

void AchievementBeforeUpdateEventHandler([[AchievementBeforeUpdateEventArgs In-Process API Event Argument|AchievementBeforeUpdateEventArgs]] e);

Properties

Name	Type	Description	Default	Options
ContentTypeId	`Guid`

Methods

Achievement Create(string title, string criteria, string badgeIconName, Byte[] badgeIconData, AchievementCreateOptions options = null);

Obsolete. OBSOLETE in 12: Use Create overload that takes BadgeIconUploadContext instead.

Create an achievement. OBSOLETE in 12: Use Create overload that takes BadeIconUploadContext instead.

Parameters

Name	Type	Description	Required
title	`string`	Title	Required
criteria	`string`	Criteria	Required
badgeIconName	`string`	Badge Icon Name	Required
badgeIconData	`Byte[]`	Badge Icon Data	Required
options	`[[AchievementCreateOptions In-Process API Supplementary Type\|AchievementCreateOptions]]`	Options	Optional

Return Type

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

Achievement Create(string title, string criteria, string badgeIconName, Stream badgeIconStream, AchievementCreateOptions options = null);

Obsolete. OBSOLETE in 12: Use Create overload that takes BadgeIconUploadContext instead.

Create an achievement. OBSOLETE in 12: Use Create overload that takes BadeIconUploadContext instead.

Parameters

Name	Type	Description	Required
title	`string`	Title	Required
criteria	`string`	Criteria	Required
badgeIconName	`string`	Badge Icon Name	Required
badgeIconStream	`Stream`	Badge Icon Stream	Required
options	`[[AchievementCreateOptions In-Process API Supplementary Type\|AchievementCreateOptions]]`	Options	Optional

Return Type

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

Achievement Create(string title, string criteria, string badgeIconName, string badgeIconUploadContext, AchievementCreateOptions options = null);

Create an achievement

Parameters

Name	Type	Description	Required
title	`string`	Title	Required
criteria	`string`	Criteria	Required
badgeIconName	`string`	Badge Icon Name	Required
badgeIconUploadContext	`string`	Badge Icon Upload Context	Required
options	`[[AchievementCreateOptions In-Process API Supplementary Type\|AchievementCreateOptions]]`	Options	Optional

Return Type

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

AdditionalInfo Delete(Guid achievementId);

Delete achievement by its Id

Parameters

Name	Type	Description	Required	Default	Options
achievementId	`Guid`	Achievement Id	Required

Return Type

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

Achievement Get(Guid achievementId);

Gets an achievement by its Id

Parameters

Name	Type	Description	Required	Default	Options
achievementId	`Guid`	Achievement Id	Required

Return Type

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

PagedList<Achievement> List(AchievementListOptions options = null);

List achievements

Parameters

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

Return Type

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

Achievement Update(Guid id, AchievementUpdateOptions options);

Update an achievement

Parameters

Name	Type	Description	Required	Default	Options
id	`Guid`	Id	Required
options	`[[AchievementUpdateOptions In-Process API Supplementary Type\|AchievementUpdateOptions]]`	Options	Required

Return Type

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