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