Method GetVersionPlayerRangeAsync

GetVersionPlayerRangeAsync(string, string, GetVersionPlayerRangeOptions)

Gets the entries of the current player as well as the specified number of neighboring players ranked either side of the player in the specified leaderboard archive version.

Declaration

Task<LeaderboardVersionScores> GetVersionPlayerRangeAsync(string leaderboardId, string versionId, GetVersionPlayerRangeOptions options = null)

Parameters

Type	Name	Description
string	leaderboardId	ID string of the leaderboard
string	versionId	ID string of the leaderboard archive version
GetVersionPlayerRangeOptions	options	Options object with "RangeLimit", the number of entries either side of the player to retrieve (defaults to 5), and IncludeMetadata, whether to retrieve stored metadata (defaults to false).

Returns

Type	Description
Task<LeaderboardVersionScores>	Task for a Response object containing status code, headers, and Models.LeaderboardVersionScores 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.