Method GetPlayerScoreAsync
GetPlayerScoreAsync(string, GetPlayerScoreOptions)
Gets the entry for the current player in the specified leaderboard.
Declaration
Task<LeaderboardEntry> GetPlayerScoreAsync(string leaderboardId, GetPlayerScoreOptions options = null)Parameters
| Type | Name | Description |
|---|---|---|
| string | leaderboardId | ID string of the leaderboard |
| GetPlayerScoreOptions | options | Options object with "IncludeMetadata", whether to retrieve stored metadata (defaults to false). |
Returns
| Type | Description |
|---|---|
| Task<LeaderboardEntry> | Task for a Response object containing status code, headers, and Models.LeaderboardEntry object containing the retrieved entry. |
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. |