Method GetScoresByTierAsync
GetScoresByTierAsync(string, string, GetScoresByTierOptions)
Gets a paginated list of entries for the specified leaderboard within the specified tier.
Declaration
Task<LeaderboardTierScoresPage> GetScoresByTierAsync(string leaderboardId, string tierId, GetScoresByTierOptions options = null)Parameters
| Type | Name | Description |
|---|---|---|
| string | leaderboardId | ID string of the leaderboard |
| string | tierId | ID string of the tier |
| GetScoresByTierOptions | options | Options object with "Offset" and "Limit" pagination options, and "IncludeMetadata" options. "Offset" is the number of entries to skip when retrieving the leaderboard scores, defaults to 0. "Limit" is the number of leaderboard scores to return, defaults to 10. "IncludeMetadata" is whether to return stored metadata, defaults to false. |
Returns
| Type | Description |
|---|---|
| Task<LeaderboardTierScoresPage> | Task for a Response object containing status code, headers, and Models.LeaderboardTierScoresPage object containing the paginated list of retrieved entries. |
Exceptions
| Type | Condition |
|---|---|
| LeaderboardsException | An exception containing a Message, Reason, and ErrorCode that can be used to determine the source of the error. |
| LeaderboardsValidationException | An exception containing a Message, Reason, ErrorCode, and Details that can be used to determine the source of the error. |