LeaderboardService.GetLeaderboardForSocialGroupWithSkipToUserAsync Method

Reference

Definition

Namespace:: Microsoft.Xbox.Services.Leaderboard

Assembly:: Microsoft.Xbox.Services.dll

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.

Get a sorted leaderboard, starting at a specified player, that shows members of a specified social group.

public Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.Leaderboard.LeaderboardResult> GetLeaderboardForSocialGroupWithSkipToUserAsync (string xboxUserId, string serviceConfigurationId, string statisticName, string socialGroup, string skipToXboxUserId, string sortOrder, uint maxItems);

abstract member GetLeaderboardForSocialGroupWithSkipToUserAsync : string * string * string * string * string * string * uint32 -> Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.Leaderboard.LeaderboardResult>
override this.GetLeaderboardForSocialGroupWithSkipToUserAsync : string * string * string * string * string * string * uint32 -> Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.Leaderboard.LeaderboardResult>

Public Function GetLeaderboardForSocialGroupWithSkipToUserAsync (xboxUserId As String, serviceConfigurationId As String, statisticName As String, socialGroup As String, skipToXboxUserId As String, sortOrder As String, maxItems As UInteger) As IAsyncOperation(Of LeaderboardResult)

Parameters

xboxUserId: String

The Xbox user ID of the requesting user.

serviceConfigurationId: String

The service configuration ID (SCID) of the title

statisticName: String

The name of the statistic to get a leaderboard for.

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.

sortOrder: String

A value indicating the sort order for the returned leaderboard result. The possible values are 'ascending' or 'descending', without quotes.

maxItems: UInt32

The maximum number of items to retrieve.

Returns

Windows.Foundation.IAsyncOperation<LeaderboardResult>

A LeaderboardResult object that contains a page of leaderboard results around the specified player regardless of that player's rank or score. 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

Microsoft.Xbox.Services.Leaderboard.__ILeaderboardServicePublicNonVirtuals.GetLeaderboardForSocialGroupWithSkipToUserAsync(System.String,System.String,System.String,System.String,System.String,System.String,System.UInt32)

Remarks

There is no continuation Token provided for this query.

Calls V1 GET https://leaderboards.xboxlive.com/users/xuid({xuid})/scids/{scid}/stats/{statname}/people/{all|favorites}[?sort=descending|ascending]&skipToUser={skipToUser}

Applies to

Share via