Enables scripted content fragments to use Leaders
Methods
Get
Gets the leader record for the current user for the specified leaderboard
Usage
#set($leaderResponse = $core_v2_leader.Get($leaderboardId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
leaderboardId | int | Leaderboard Id | Required |
Return Type
List
Usage
#set($pagedListResponse = $core_v2_leader.List($leaderboardId, "%{PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortOrder = $sortOrderArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
leaderboardId | int | Id of the leaderboard. Required. | Required | ||
PageIndex | int | Which page of leaderboards to return. Optional. | Optional | ||
PageSize | int | Number of leaderboards to return per call. Optional. | Optional | ||
SortOrder | string | Ascending or descending order (by rank). Optional. | Optional | Ascending, Descending |