LeaderboardService.GetLeaderboardWithSkipToUserAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| GetLeaderboardWithSkipToUserAsync(String, String, String, UInt32) |
Get a leaderboard starting at a specified player, regardless of the player's rank or score, ordered by the player's percentile rank. |
| GetLeaderboardWithSkipToUserAsync(String, String, String, String, String, UInt32) |
Get a leaderboard starting at a specified player, regardless of the player's rank or score, ordered by the player's percentile rank. |
GetLeaderboardWithSkipToUserAsync(String, String, String, UInt32)
Get a leaderboard starting at a specified player, regardless of the player's rank or score, ordered by the player's percentile rank.
[Windows.Foundation.Metadata.Overload("GetLeaderboardWithSkipToUserAsync2")]
public Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.Leaderboard.LeaderboardResult> GetLeaderboardWithSkipToUserAsync (string serviceConfigurationId, string leaderboardName, string skipToXboxUserId, uint maxItems);abstract member GetLeaderboardWithSkipToUserAsync : string * string * string * uint32 -> Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.Leaderboard.LeaderboardResult>
override this.GetLeaderboardWithSkipToUserAsync : string * string * string * uint32 -> Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.Leaderboard.LeaderboardResult>Public Function GetLeaderboardWithSkipToUserAsync (serviceConfigurationId As String, leaderboardName As String, skipToXboxUserId As String, maxItems As UInteger) As IAsyncOperation(Of LeaderboardResult)Parameters
- serviceConfigurationId
- String
The service configuration ID (SCID) of the title
- leaderboardName
- String
The name of the leaderboard.
- skipToXboxUserId
- String
The Xbox user ID of the player to skip to before retrieving results.
- maxItems
- UInt32
The maximum number of items to return.
Returns
A LeaderboardResult object containing a collection of the leaderboard columns and rows. The result page is ordered by percentile rank, with the specified player in the last position of the page for predefined views, or in the middle for stat leaderboard views.
Implements
- Attributes
-
Windows.Foundation.Metadata.OverloadAttribute
Remarks
There is no continuation Token provided for this query.
Returns an IAsyncOperation<TResult> object that represents the state of the asynchronous operation. Completion of the asynchronous operation is signaled by using a handler that is passed to the IAsyncOperation<TResult>.Completed property. When the asynchronous operation is complete, the result of the operation can be retrieved by using the IAsyncOperation<TResult>.GetResults method.
Calls V3 GET /scids/{scid}/leaderboards/{leaderboardname}?[&skipToUser={xuid}][&maxItems={maxItems}]
Applies to
GetLeaderboardWithSkipToUserAsync(String, String, String, String, String, UInt32)
Get a leaderboard starting at a specified player, regardless of the player's rank or score, ordered by the player's percentile rank.
[Windows.Foundation.Metadata.Overload("GetLeaderboardWithSkipToUserAsync1")]
public Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.Leaderboard.LeaderboardResult> GetLeaderboardWithSkipToUserAsync (string serviceConfigurationId, string leaderboardName, string xuid, string socialGroup, string skipToXboxUserId, uint maxItems);abstract member GetLeaderboardWithSkipToUserAsync : string * string * string * string * string * uint32 -> Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.Leaderboard.LeaderboardResult>
override this.GetLeaderboardWithSkipToUserAsync : string * string * string * string * string * uint32 -> Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.Leaderboard.LeaderboardResult>Public Function GetLeaderboardWithSkipToUserAsync (serviceConfigurationId As String, leaderboardName As String, xuid As String, socialGroup As String, skipToXboxUserId As String, maxItems As UInteger) As IAsyncOperation(Of LeaderboardResult)Parameters
- serviceConfigurationId
- String
The service configuration ID (SCID) of the title
- leaderboardName
- String
The name of the leaderboard.
- xuid
- String
- socialGroup
- String
The name of the group of users to get get leaderboard results for. See Microsoft::Xbox::Services::Social::SocialGroupConstants for the latest options.
- skipToXboxUserId
- String
The Xbox user ID of the player to skip to before retrieving results.
- maxItems
- UInt32
The maximum number of items to return.
Returns
A LeaderboardResult object containing a collection of the leaderboard columns and rows. The result page is ordered by percentile rank, with the specified player in the last position of the page for predefined views, or in the middle for stat leaderboard views.
Implements
- Attributes
-
Windows.Foundation.Metadata.OverloadAttribute
Remarks
There is no continuation Token provided for this query.
Returns an IAsyncOperation<TResult> object that represents the state of the asynchronous operation. Completion of the asynchronous operation is signaled by using a handler that is passed to the IAsyncOperation<TResult>.Completed property. When the asynchronous operation is complete, the result of the operation can be retrieved by using the IAsyncOperation<TResult>.GetResults method.
Calls V3 GET /scids/{scid}/leaderboards/{leaderboardname}?[&skipToUser={xuid}][&maxItems={maxItems}]