This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.ILeaderboards>() and is defined in Telligent.Evolution.Platform.dll
Events
Events.AfterCreate
Handler
void LeaderboardAfterCreateEventHandler(LeaderboardAfterCreateEventArgs e);
Events.AfterDelete
Handler
void LeaderboardAfterDeleteEventHandler(LeaderboardAfterDeleteEventArgs e);
Events.AfterUpdate
Handler
void LeaderboardAfterUpdateEventHandler(LeaderboardAfterUpdateEventArgs e);
Events.BeforeCreate
Handler
void LeaderboardBeforeCreateEventHandler(LeaderboardBeforeCreateEventArgs e);
Events.BeforeDelete
Handler
void LeaderboardBeforeDeleteEventHandler(LeaderboardBeforeDeleteEventArgs e);
Events.BeforeUpdate
Handler
void LeaderboardBeforeUpdateEventHandler(LeaderboardBeforeUpdateEventArgs e);
Events.Render
Handler
void LeaderboardRenderEventHandler(LeaderboardRenderEventArgs e);
Properties
| Name | Type | Description | Default | Options |
|---|---|---|---|---|
| ContentTypeId | Guid | Leaderboard Application Type |
Methods
Leaderboard Create(string name, int numberOfLeaders, LeaderboardCreateOptions options = null);
Creates a new point leaderboard
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| name | string | Name of the point leaderboard | Required | ||
| numberOfLeaders | int | Number of leaders to track | Required | ||
| options | LeaderboardCreateOptions | Optional parameter names are: ContainerId, StartDate, EndDate, TimeSpanValue, TimeSpanType, PeriodType | Optional |
Return Type
AdditionalInfo Delete(int leaderboardId);
Deletes a point leaderboard
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| leaderboardId | int | Id of leaderboard to update | Required |
Return Type
Leaderboard Get(int leaderboardId);
Gets an existing leaderboard by Id
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| leaderboardId | int | Leaderboard unique identifier | Required |
Return Type
Leaderboard Get(Guid contentId);
Gets an existing leaderboard by ContentId
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| contentId | Guid | Leaderboard content identifier | Required |
Return Type
Leaderboard Get(string applicationKey, Guid? containerId);
Gets an existing leaderboard by ApplicationKey
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| applicationKey | string | Leaderboard application key | Required | ||
| containerId | Guid? | Leaderboard container identifier | Required |
Return Type
PagedList<Leaderboard> List(LeaderboardListOptions options = null);
Lists point leaderboards in alphabetical order
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| options | LeaderboardListOptions | Optional parameter names are: ContainerId, Scope, Status, PageSize, PageIndex, SortOrder | Optional |
Return Type
Leaderboard Update(int leaderboardId, LeaderboardUpdateOptions options = null);
Updates an existing point leaderboard
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| leaderboardId | int | Id of leaderboard to update | Required | ||
| options | LeaderboardUpdateOptions | Optional parameter names are: Name, NumberOfLeaders, ContainerId, StartDate, EndDate, TimeSpanValue, TimeSpanType, PeriodType | Optional |
Return Type
bool UserIsEligible(int leaderboardId);
Leaderboard Application Type
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| leaderboardId | int | Leaderboard Id | Required |
Return Type
bool