| BrainCloudServiceClientSocialLeaderboard_GetSocialLeaderboardAsync Method |
[This is preliminary documentation and is subject to change.]
Method returns the social leaderboard. A player's social leaderboard is
comprised of players who are recognized as being your friend.
For now, this applies solely to Facebook connected players who are
friends with the logged in player (who also must be Facebook connected).
In the future this will expand to other identification means (such as
Game Centre, Google circles etc).
Leaderboards entries contain the player's score and optionally, some user-defined
data associated with the score. The currently logged in player will also
be returned in the social leaderboard.
Note: If no friends have played the game, the bestScore, createdAt, updatedAt
will contain NULL.
Namespace:
Ruyi.SDK.BrainCloudApi
Assembly:
SDK.Gen.ServiceAsync (in SDK.Gen.ServiceAsync.dll) Version: 0.9.3.3995
Syntax public Task<string> SocialLeaderboard_GetSocialLeaderboardAsync(
string leaderboardId,
bool replaceName,
int clientIndex,
CancellationToken cancellationToken
)
Parameters
- leaderboardId
- Type: SystemString
The id of the leaderboard to retrieve - replaceName
- Type: SystemBoolean
If true, the currently logged in player's name will be replaced
by the string "You". - clientIndex
- Type: SystemInt32
@BrainCloud_clientIndex_desc - cancellationToken
- Type: System.ThreadingCancellationToken
[Missing <param name="cancellationToken"/> documentation for "M:Ruyi.SDK.BrainCloudApi.BrainCloudService.Client.SocialLeaderboard_GetSocialLeaderboardAsync(System.String,System.Boolean,System.Int32,System.Threading.CancellationToken)"]
Return Value
Type:
TaskString[Missing <returns> documentation for "M:Ruyi.SDK.BrainCloudApi.BrainCloudService.Client.SocialLeaderboard_GetSocialLeaderboardAsync(System.String,System.Boolean,System.Int32,System.Threading.CancellationToken)"]
See Also