This type defines the Client main entry point for the Leaderboards feature. More...
Inheritance diagram for Beamable.Server.Api.Leaderboards.IMicroserviceLeaderboardsApi:
Collaboration diagram for Beamable.Server.Api.Leaderboards.IMicroserviceLeaderboardsApi:
Public Member Functions | |
| Promise< EmptyResponse > | CreateLeaderboard (string leaderboardId, LeaderboardContent templateLeaderboardContent, OptionalLong ttl=null, OptionalListString derivatives=null, OptionalLong freezeTime=null) |
| Call to create a new leaderboard with the given leaderboardId using the parameters found in the templateLeaderboardContent . Does not return an error when given an existing leaderboardId . Instead, returns a success without any alteration made to the existing leaderboard that matches leaderboardId . More... | |
| Promise< EmptyResponse > | CreateLeaderboard (string leaderboardId, OptionalInt maxEntries, OptionalLong ttl, OptionalBoolean partitioned, OptionalCohortSettings cohortSettings, OptionalListString derivatives, OptionalClientPermissions permissions, OptionalLong freezeTime) |
| Call to create a leaderboard without a template as a base. More... | |
| Promise< EmptyResponse > | CreateLeaderboard (string leaderboardId, CreateLeaderboardRequest req) |
| Call to create a leaderboard without a template as a base. | |
| Promise< ListLeaderboardResult > | ListLeaderboards (int? skip=null, int? limit=50) |
| Get a list of all available leaderboard ids. More... | |
| Promise< GetPlayerLeaderboardsResponse > | GetPlayerLeaderboards (long gamerTag) |
| Get a list of all the leaderboards that a specific player is participating in. More... | |
 Public Member Functions inherited from Beamable.Common.Api.Leaderboards.ILeaderboardApi | |
| UserDataCache< RankEntry > | GetCache (string boardId) |
| Get the UserDataCache<RankEntry> with RankEntry values for some leaderboard ID. More... | |
| Promise< LeaderboardAssignmentInfo > | GetAssignment (string boardId, bool joinBoard) |
| For partitioned or cohorted leaderboards Resolves the specific child leaderboard the player is assigned to e.g. "leaderboards.my_partitioned_board" -> "leaderboards.my_partitioned_board#0" – where #0 denotes the partition identifier More... | |
| Promise< LeaderboardAssignmentInfo > | ResolveAssignment (string boardId, long gamerTag) |
| For partitioned or cohorted leaderboards Resolves the specific child leaderboard the player is assigned to Uses a cache to avoid repeat communication with the server More... | |
| Promise< RankEntry > | GetUser (LeaderboardRef leaderBoard, long gamerTag) |
| Get the rank of a specific player on a specific leaderboard More... | |
| Promise< RankEntry > | GetUser (string boardId, long gamerTag) |
| Get the rank of a specific player on a specific leaderboard More... | |
| Promise< LeaderBoardView > | GetBoard (LeaderboardRef leaderBoard, int from, int max, long? focus=null, long? outlier=null) |
| Get a view with ranking of a specific leaderboard More... | |
| Promise< LeaderBoardView > | GetBoard (string boardId, int from, int max, long? focus=null, long? outlier=null) |
| Get a view with ranking of a specific leaderboard More... | |
| Promise< LeaderBoardView > | GetAssignedBoard (LeaderboardRef leaderBoard, int from, int max, long? focus=null, long? outlier=null) |
| For partitioned or cohorted leaderboards Get a view with rankings of child leaderboard the current player is assigned to More... | |
| Promise< LeaderBoardView > | GetAssignedBoard (string boardId, int from, int max, long? focus=null, long? outlier=null) |
| For partitioned or cohorted leaderboards Get a view with rankings of child leaderboard the current player is assigned to More... | |
| Promise< LeaderBoardView > | GetRanks (LeaderboardRef leaderBoard, List< long > ids) |
| Get a specific list of rankings by player id/gamertag from a leaderboard More... | |
| Promise< LeaderBoardView > | GetRanks (string boardId, List< long > ids) |
| Get a specific list of rankings by player id/gamertag from a leaderboard More... | |
| Promise< EmptyResponse > | SetScore (LeaderboardRef leaderBoard, double score, IDictionary< string, object > stats=null) |
| Replace the score of the current player Cohorted and Partitioned leaderboards will automatically update the correct child leaderboard More... | |
| Promise< EmptyResponse > | SetScore (string boardId, double score, IDictionary< string, object > stats=null) |
| Replace the score of the current player Cohorted and Partitioned leaderboards will automatically update the correct child leaderboard More... | |
| Promise< EmptyResponse > | IncrementScore (LeaderboardRef leaderBoard, double score, IDictionary< string, object > stats=null) |
| Increment (add to) the score of the current player Cohorted and Partitioned leaderboards will automatically update the correct child leaderboard More... | |
| Promise< EmptyResponse > | IncrementScore (string boardId, double score, IDictionary< string, object > stats=null) |
| Increment (add to) the score of the current player Cohorted and Partitioned leaderboards will automatically update the correct child leaderboard More... | |
| Promise< LeaderBoardView > | GetFriendRanks (LeaderboardRef leaderboard) |
| Get the rankings of the current player's friends participating in this leaderboard More... | |
| Promise< LeaderBoardView > | GetFriendRanks (string boardId) |
| Get the rankings of the current player's friends participating in this leaderboard More... | |
Detailed Description
This type defines the Client main entry point for the Leaderboards feature.
Related Links
- See the Leaderboards feature documentation
- See Beamable.Server.IBeamableServices script reference
Member Function Documentation
◆ CreateLeaderboard() [1/2]
| Promise< EmptyResponse > Beamable.Server.Api.Leaderboards.IMicroserviceLeaderboardsApi.CreateLeaderboard | ( | string | leaderboardId, |
| LeaderboardContent | templateLeaderboardContent, | ||
| OptionalLong | ttl = null, |
||
| OptionalListString | derivatives = null, |
||
| OptionalLong | freezeTime = null |
||
| ) |
Call to create a new leaderboard with the given leaderboardId using the parameters found in the templateLeaderboardContent . Does not return an error when given an existing leaderboardId . Instead, returns a success without any alteration made to the existing leaderboard that matches leaderboardId .
- Parameters
-
leaderboardId Id for the new leaderboard. Caller must guarantee this to be unique. templateLeaderboardContent Template parameters that'll be used to create the new leaderboard. ttl When this leaderboard should expire. derivatives Board Ids for boards that must be recalculated when a entry is updated in this board. freezeTime An arbitrary time since jan 1st 1970 when this leaderboard should be frozen
◆ CreateLeaderboard() [2/2]
| Promise< EmptyResponse > Beamable.Server.Api.Leaderboards.IMicroserviceLeaderboardsApi.CreateLeaderboard | ( | string | leaderboardId, |
| OptionalInt | maxEntries, | ||
| OptionalLong | ttl, | ||
| OptionalBoolean | partitioned, | ||
| OptionalCohortSettings | cohortSettings, | ||
| OptionalListString | derivatives, | ||
| OptionalClientPermissions | permissions, | ||
| OptionalLong | freezeTime | ||
| ) |
Call to create a leaderboard without a template as a base.
- Parameters
-
leaderboardId Id for the new leaderboard. Caller must guarantee this to be unique. maxEntries Maximum number of players who can be in the leaderboard. ttl When this leaderboard should expire. partitioned Whether or not the leaderboard should be partitioned into N "maxEntries" boards. cohortSettings Stats-based filter that's used to group together leaderboard entries. derivatives Board Ids for boards that must be recalculated when a entry is updated in this board. permissions Whether or not a client can write to this leaderboard freezeTime An arbitrary time since jan 1st 1970 when this leaderboard should be frozen
◆ GetPlayerLeaderboards()
| Promise< GetPlayerLeaderboardsResponse > Beamable.Server.Api.Leaderboards.IMicroserviceLeaderboardsApi.GetPlayerLeaderboards | ( | long | gamerTag | ) |
Get a list of all the leaderboards that a specific player is participating in.
- Parameters
-
gamerTag The gamertag of the player to find leaderboards for.
- Returns
- A Promise containing a GetPlayerLeaderboardsResponse that has a set of LeaderBoardViews
◆ ListLeaderboards()
| Promise< ListLeaderboardResult > Beamable.Server.Api.Leaderboards.IMicroserviceLeaderboardsApi.ListLeaderboards | ( | int? | skip = null, |
| int? | limit = 50 |
||
| ) |
Get a list of all available leaderboard ids.
- Parameters
-
skip An optional number of leaderboard ids to skip. By default, no leaderboards will be skipped. Use this with the limit argument to page the results. limit An optional maximum number of leaderboard ids to return. By default, the limit will be 50. Use this with the skip argument to page the results.
- Returns
- A Promise containing a ListLeaderboardResult that has the leaderboard ids.
The documentation for this interface was generated from the following file:
- com.beamable.server/SharedRuntime/Api/Leaderboards/IMicroserviceLeaderboardsApi.cs
