This type defines the Client main entry point for the Leaderboards feature. More...
Inheritance diagram for Beamable.Api.Leaderboard.LeaderboardService:
Collaboration diagram for Beamable.Api.Leaderboard.LeaderboardService:
Public Member Functions | |
| LeaderboardService (IPlatformService platform, IBeamableRequester requester, IDependencyProvider provider, UserDataCache< RankEntry >.FactoryFunction cacheFactory) | |
 Public Member Functions inherited from Beamable.Common.Api.Leaderboards.LeaderboardApi | |
| LeaderboardApi (IBeamableRequester requester, IUserContext userContext, IDependencyProvider provider, UserDataCache< RankEntry >.FactoryFunction factoryFunction) | |
| 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) |
| Promise< LeaderBoardView > | GetBoard (string boardId, int @from, int max, long? focus=null, long? outlier=null) |
| Promise< LeaderBoardView > | GetAssignedBoard (string boardId, int @from, int max, long? focus=null, long? outlier=null) |
| Promise< LeaderBoardView > | GetAssignedBoard (LeaderboardRef leaderBoard, int @from, int max, long? focus=null, long? outlier=null) |
| 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... | |
| 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... | |
| Public Member Functions inherited from Beamable.Common.Api.Leaderboards.ILeaderboardApi | |
| 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... | |
Additional Inherited Members | |
| Protected Member Functions inherited from Beamable.Common.Api.Leaderboards.LeaderboardApi | |
| Promise< EmptyResponse > | Update (string boardId, double score, bool increment=false, IDictionary< string, object > stats=null) |
| Properties inherited from Beamable.Common.Api.Leaderboards.LeaderboardApi | |
| IBeamableRequester | Requester [get] |
| IUserContext | UserContext [get] |
| IDependencyProvider | Provider [get] |
Detailed Description
This type defines the Client main entry point for the Leaderboards feature.
Related Links
- See the Leaderboards feature documentation
- See Beamable.API script reference
The documentation for this class was generated from the following file:
- com.beamable/Runtime/Core/Platform/SDK/Leaderboard/LeaderboardService.cs
