PlayFab.Client.Models.GetFriendLeaderboardAroundPlayerRequest

Services
Client
PlayFab.Client.Models.GetFriendLeaderboardAroundPlayerRequest

Request Properties
IncludeFacebookFriends Boolean Indicates whether Facebook friends should be included in the response. Default is true.
IncludeSteamFriends Boolean Indicates whether Steam service friends should be included in the response. Default is true.
MaxResultsCount int32 Maximum number of entries to retrieve. Default 10, maximum 100.
PlayFabId String PlayFab unique identifier of the user to center the leaderboard around. If null will center on the logged in user.
ProfileConstraints PlayerProfileViewConstraints If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client, only the allowed client profile properties for the title may be requested. These allowed properties are configured in the Game Manager "Client Profile Options" tab in the "Settings" section.
StatisticName (required) String Statistic used to rank players for this leaderboard.
UseSpecificVersion (Governs: Version) Boolean If set to false, Version is considered null. If true, uses the specified Version
Version int32 The version of the leaderboard to get.
XboxToken String Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab.

Request Properties

IncludeFacebookFriends Boolean

Indicates whether Facebook friends should be included in the response. Default is true.

IncludeSteamFriends Boolean

Indicates whether Steam service friends should be included in the response. Default is true.

MaxResultsCount int32

Maximum number of entries to retrieve. Default 10, maximum 100.

PlayFabId String

PlayFab unique identifier of the user to center the leaderboard around. If null will center on the logged in user.

ProfileConstraints PlayerProfileViewConstraints

If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client, only the allowed client profile properties for the title may be requested. These allowed properties are configured in the Game Manager "Client Profile Options" tab in the "Settings" section.

StatisticName (required) String

Statistic used to rank players for this leaderboard.

UseSpecificVersion (Governs: Version) Boolean

If set to false, Version is considered null. If true, uses the specified Version

Version int32

The version of the leaderboard to get.

XboxToken String

Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab.