GetSocialLeaderboardByVersion

Note that friend summary data is returned for each record in the leaderboard.

Method returns the social leaderboard by version. A player's social leaderboard is comprised of players who are recognized as being your friend. It includes

• All external friends (Facebook, Steam, PlaystationNetwork)
• All internal friends (brainCloud)
• Plus “self”.

Leaderboards entries contain the player's score and optionally, some user-data associated with the score. The currently logged in player will also be returned in the social leaderboard.

caution

If no friends have played the game, the bestScore, createdAt, update will contain NULL.

Service	Operation
leaderboard	GET_SOCIAL_LEADERBOARD_BY_VERSION

Method Parameters

Parameter	Description
leaderboardId	The id of the leaderboard to retrieve
replaceName	If true, the currently logged in player's name will be replaced by the string "You"
version	Leaderboard version to get

Usage

http://localhost:3000

C#

string leaderboardId = "default";
bool replaceName = false;
int versionId = 1;
SuccessCallback successCallback = (response, cbObject) =>
{
    Debug.Log(string.Format("Success | {0}", response));
};
FailureCallback failureCallback = (status, code, error, cbObject) =>
{
    Debug.Log(string.Format("Failed | {0}  {1}  {2}", status, code, error));
};

_bc.LeaderboardService.GetSocialLeaderboardByVersion(leaderboardId, replaceName, versionId, successCallback, failureCallback);

C++

const char *leaderboardId = "default";
bool replaceName = false;
int versionId = 1;
_bc->getLeaderboardService()->getSocialLeaderboardByVersion(leaderboardId, replaceName, versionId, this);

Objective-C

NSString *leaderboardId = @"default";
bool replaceName = false;
int versionId = 1;
BCCompletionBlock successBlock;      // define callback
BCErrorCompletionBlock failureBlock; // define callback

[[_bc leaderboardService] getSocialLeaderboardByVersion:leaderboardId
                replaceName:replaceName
                  versionId:versionId
            completionBlock:successBlock
       errorCompletionBlock:failureBlock
                   cbObject:nil];

Java

String leaderboardId = "default";
boolean replaceName = false;
int versionId = 1;
this; // implements IServerCallback

_bc.getLeaderboardService().getSocialLeaderboardByVersion(leaderboardId, replaceName, versionId, this);

public void serverCallback(ServiceName serviceName, ServiceOperation serviceOperation, JSONObject jsonData)
{
    System.out.print(String.format("Success | %s", jsonData.toString()));
}
public void serverError(ServiceName serviceName, ServiceOperation serviceOperation, int statusCode, int reasonCode, String jsonError)
{
    System.out.print(String.format("Failed | %d %d %s", statusCode,  reasonCode, jsonError.toString()));
}

JavaScript

var leaderboardId = "default";
var replaceName = false;
var versionId = 1;

_bc.leaderboard.getSocialLeaderboardByVersion(leaderboardId, replaceName, versionId, result =>
{
    var status = result.status;
    console.log(status + " : " + JSON.stringify(result, null, 2));
});

Dart

var  leaderboardId = "default";
var  replaceName = false;
var  versionId = 1;

ServerResponse result = await _bc.leaderboardService.getSocialLeaderboardByVersion(leaderboardId:leaderboardId, replaceName:replaceName, versionId:versionId);

if (result.statusCode == 200) {
    print("Success");
} else {
    print("Failed ${result.error['status_message'] ?? result.error}");
}

Cloud Code

var leaderboardId = "default";
var replaceName = false;
var versionId = 1;
var leaderboardProxy = bridge.getLeaderboardServiceProxy();

var postResult = leaderboardProxy.getSocialLeaderboardByVersion(leaderboardId, replaceName, versionId);
if (postResult.status == 200) {
    // Success!
}

Raw

{
    "service": "leaderboard",
    "operation": "GET_SOCIAL_LEADERBOARD_BY_VERSION",
    "data": {
        "leaderboardId": "default",
        "replaceName": false,
        "versionId": 1
    }
}

JSON Response

{
    "status" : 200,
    "data" :
    {
        "social_leaderboard": [
            {
                "updatedAt": 1395840936348,
                "pictureUrl": null,
                "playerId": "26f8bb07-3e94-458b-8485-f9031c3a6ef1",
                "createdAt": 1395840936348,
                "name": "You",
                "otherData": null,
                "authenticationType": null,
                "externalId": null,
                "summaryFriendData": null,
                "score": 20000
            },
            {
                "updatedAt": 1395840936351,
                "pictureUrl": null,
                "playerId": "3ad8bc09-4a34-e324-1231-3b2c1c3a6bc6",
                "createdAt": 1395840936351,
                "name": "Jenny Goldsmith",
                "otherData": null,
                "authenticationType": null,
                "externalId": null,
                "summaryFriendData": null,
                "score": 10000
            }
        ],
        "timeBeforeReset": 588182412,
        "server_time": 1395840957588
    }
}