Method GetScoresByPlayerIdsAsync
GetScoresByPlayerIdsAsync(string, List<string>, GetScoresByPlayerIdsOptions)
Gets a list of entries from the specified leaderboard for the specified player IDs.
Declaration
Task<LeaderboardScoresWithNotFoundPlayerIds> GetScoresByPlayerIdsAsync(string leaderboardId, List<string> playerIds, GetScoresByPlayerIdsOptions options = null)
Parameters
Type | Name | Description |
---|---|---|
string | leaderboardId | ID string of the leaderboard |
List<string> | playerIds | List of player IDs to get entries for |
GetScoresByPlayerIdsOptions | options | Options object with "IncludeMetadata", whether to retrieve stored metadata (defaults to false). |
Returns
Type | Description |
---|---|
Task<LeaderboardScoresWithNotFoundPlayerIds> | Task for a Response object containing status code, headers, and Models.LeaderboardScores object containing the 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. |