LeaderboardService.GetLeaderboardForSocialGroupAsync 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
| GetLeaderboardForSocialGroupAsync(String, String, String, String, UInt32) |
Get an unsorted leaderboard that shows members of a specified social group. |
| GetLeaderboardForSocialGroupAsync(String, String, String, String, String, UInt32) |
Get a sorted leaderboard that shows members of a specified social group. |
GetLeaderboardForSocialGroupAsync(String, String, String, String, UInt32)
Get an unsorted leaderboard that shows members of a specified social group.
[Windows.Foundation.Metadata.Overload("GetLeaderboardForSocialGroupAsync2")]
public Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.Leaderboard.LeaderboardResult> GetLeaderboardForSocialGroupAsync (string xboxUserId, string serviceConfigurationId, string statisticName, string socialGroup, uint maxItems);abstract member GetLeaderboardForSocialGroupAsync : string * string * string * string * uint32 -> Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.Leaderboard.LeaderboardResult>
override this.GetLeaderboardForSocialGroupAsync : string * string * string * string * uint32 -> Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.Leaderboard.LeaderboardResult>Public Function GetLeaderboardForSocialGroupAsync (xboxUserId As String, serviceConfigurationId As String, statisticName As String, socialGroup 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.
- maxItems
- UInt32
The maximum number of items to retrieve.
Returns
A LeaderboardResult object containing a collection of the leaderboard columns and rows.
Implements
- Attributes
-
Windows.Foundation.Metadata.OverloadAttribute
Remarks
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 V1 GET https://leaderboards.xboxlive.com/users/xuid({xuid})/scids/{scid}/stats/{statname}/people/{all|favorites}
Applies to
GetLeaderboardForSocialGroupAsync(String, String, String, String, String, UInt32)
Get a sorted leaderboard that shows members of a specified social group.
[Windows.Foundation.Metadata.Overload("GetLeaderboardForSocialGroupAsync1")]
public Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.Leaderboard.LeaderboardResult> GetLeaderboardForSocialGroupAsync (string xboxUserId, string serviceConfigurationId, string statisticName, string socialGroup, string sortOrder, uint maxItems);abstract member GetLeaderboardForSocialGroupAsync : string * string * string * string * string * uint32 -> Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.Leaderboard.LeaderboardResult>
override this.GetLeaderboardForSocialGroupAsync : string * string * string * string * string * uint32 -> Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.Leaderboard.LeaderboardResult>Public Function GetLeaderboardForSocialGroupAsync (xboxUserId As String, serviceConfigurationId As String, statisticName As String, socialGroup 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.
- 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
A LeaderboardResult object containing a collection of the leaderboard columns and rows.
Implements
- Attributes
-
Windows.Foundation.Metadata.OverloadAttribute
Remarks
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 V1 GET https://leaderboards.xboxlive.com/users/xuid({xuid})/scids/{scid}/stats/{statname}/people/{all|favorites}[?sort=descending|ascending]