This type defines the Microservice main entry point for the Tournaments feature. More...
Inheritance diagram for Beamable.Server.Api.Tournament.IMicroserviceTournamentApi:
Collaboration diagram for Beamable.Server.Api.Tournament.IMicroserviceTournamentApi:
Additional Inherited Members | |
 Public Member Functions inherited from Beamable.Common.Api.Tournaments.ITournamentApi | |
| Promise< TournamentInfo > | GetTournamentInfo (string tournamentContentId) |
| Find the first TournamentInfo that matches the given tournament content id. More... | |
| Promise< TournamentInfoResponse > | GetAllTournaments (string contentId=null, int? cycle=null, bool? isRunning=null) |
| Find all the tournaments that match given criteria. More... | |
| Promise< TournamentChampionsResponse > | GetChampions (string tournamentId, int cycleLimit=30) |
| Tournament champions are players who came in first across all stages and tiers for a given cycle. This method will fetch the latest cycle winners. Use the GetStandings method to get the standings for the current player's stage and tier. More... | |
| Promise< TournamentStandingsResponse > | GetGlobalStandings (string tournamentId, int cycle=-1, int from=-1, int max=-1, int focus=-1) |
| Players participating in a tournament are segmented into different leaderboard partitions to limit the size of the leaderboard any given player sees. Global standings are the scores across all stages, tiers, and partitions. Use the GetStandings method to get the standings for the current player's stage and tier. More... | |
| Promise< TournamentStandingsResponse > | GetStandings (string tournamentId, int cycle=-1, int from=-1, int max=-1, int focus=-1) |
| Retrieve the scores for the current player's stage and tier in the tournament. More... | |
| Promise< TournamentStandingsResponse > | GetGroupPlayers (string tournamentId, int cycle=-1, int from=-1, int max=-1, int focus=-1) |
| Retrieve scores for the the group members in the current player's group. More... | |
| Promise< TournamentGroupsResponse > | GetGroups (string tournamentId, int cycle=-1, int from=-1, int max=-1, int focus=-1) |
| Retrieve the tournament scores for player groups. When groups participate in leaderboards, the group's score is the sum of all participating members in the group. More... | |
| Promise< TournamentRewardsResponse > | GetUnclaimedRewards (string tournamentId) |
| Retrieve a list of unclaimed rewards that the current player has earned from previous cycles of a tournament. This method can be used to show a player what rewards they will acquire before they are claimed. Use the ClaimAllRewards method to actually claim the rewards. Use the GetPlayerStatus method to identify tournaments that the player is participating in. More... | |
| Promise< TournamentRewardsResponse > | ClaimAllRewards (string tournamentId) |
| Claim all rewards that the current player has earned for previous cycles of a tournament. If you need to show the rewards before claiming them, use the GetUnclaimedRewards method. Use the GetPlayerStatus method to identify tournaments that the player is participating in. More... | |
| Promise< TournamentPlayerStatus > | JoinTournament (string tournamentId, double startScore=0) |
| A player must join a tournament before they can submit scores with the SetScore method. Once a player has joined a tournament, they will be given scores for all future cycles of the tournament. There is no way to leave a tournament. More... | |
| Promise< Unit > | SetScore (string tournamentId, long dbid, double score, bool incrementScore=false) |
| Set the tournament score for the given dbid. The player must have joined the tournament using the JoinTournament method before they can submit scores. More... | |
| Promise< TournamentPlayerStatusResponse > | GetPlayerStatus (string tournamentId=null, string contentId=null, bool? hasUnclaimedRewards=null) |
| Retrieve a set of TournamentPlayerStatuss for all matching tournaments. The TournamentPlayerStatus is a view of a tournament for the current player. More... | |
| Promise< TournamentGroupStatusResponse > | GetGroupStatus (string tournamentId=null, string contentId=null) |
| Retrieve a set of TournamentGroupStatuss for all matching tournaments. The TournamentGroupStatus is a view of a tournament for the current player, for the player's group. More... | |
| Promise< TournamentGroupStatusResponse > | GetGroupStatuses (List< long > groupIds, string contentId) |
| Retrieve a set of TournamentGroupStatuss for some set of groups for all tournaments that were spawned from the given content id. More... | |
| Promise< string > | GetPlayerAlias (long playerId, string statName="alias") |
| A utility function to get the alias for a given player. The alias will be found by looking at the player's public stat values. More... | |
| Promise< string > | GetPlayerAvatar (long playerId, string statName="avatar") |
| A utility function to get the avatar key for a given player. The avatar key will be found by looking at the player's public stat values. More... | |
Detailed Description
This type defines the Microservice main entry point for the Tournaments feature.
Related Links
- See the Tournaments feature documentation
- See Beamable.Server.IBeamableServices script reference
The documentation for this interface was generated from the following file:
- com.beamable.server/SharedRuntime/Api/Tournament/IMicroserviceTournament.cs
