GetPlayersSocialLeaderboardByVersionIfExists

Retrieve a sorted, social leaderboard of the specified list of players by version, if leaderboard exists. Silently fails, if leaderboard does not exist, just returns null and success, instead of an error.

Service	Operation
leaderboard	GET_PLAYERS_SOCIAL_LEADERBOARD_BY_VERSION_IF_EXISTS

Method Parameters

Parameter	Description
leaderboardId	The ID of the leaderboard
profileIds	The IDs of the players
versionId	The version of the leaderboard

Usage

http://localhost:3000

C#

string leaderboardId = "default";
string[] profileIds = { "profile-id", "another-profile-id" };
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.GetPlayersSocialLeaderboardByVersionIfExists(leaderboardId, profileIds, versionId, successCallback, failureCallback);

C++

const char *leaderboardId = "default";
std::vector<std::string> profileIds;
profileIds.push_back("profile-id");
profileIds.push_back("another-profile-id");
int versionId = 1;
_bc->getLeaderboardService()->getPlayersSocialLeaderboardByVersionIfExists(leaderboardId, profileIds, versionId, this);

Objective-C

NSString *leaderboardId = @"default";
NSArray *profileIds = @[ @"profile-id", @"another-profile-id" ];
int versionId = 1;
BCCompletionBlock successBlock;      // define callback
BCErrorCompletionBlock failureBlock; // define callback

[[_bc leaderboardService] getPlayersSocialLeaderboardByVersionIfExists:leaderboardId
                 profileIds:profileIds
                  versionId:versionId
            completionBlock:successBlock
       errorCompletionBlock:failureBlock
                   cbObject:nil];

Java

String leaderboardId = "default";
String[] profileIds = { "profile-id", "another-profile-id" };
int versionId = 1;
this; // implements IServerCallback

_bc.getLeaderboardService().getPlayersSocialLeaderboardByVersionIfExists(leaderboardId, profileIds, 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 profileIds = [ "profile-id", "another-profile-id" ];
var versionId = 1;

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

Dart

var  leaderboardId = "default";
var  profileIds = [ "profile-id", "another-profile-id" ];
var  versionId = 1;

ServerResponse result = await _bc.leaderboardService.getPlayersSocialLeaderboardByVersionIfExists(leaderboardId:leaderboardId, profileIds:profileIds, versionId:versionId);

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

Cloud Code

var leaderboardId = "default";
var profileIds = [ "profile-id", "another-profile-id" ];
var versionId = 1;
var leaderboardProxy = bridge.getLeaderboardServiceProxy();

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

Raw

{
    "service": "leaderboard",
    "operation": "GET_PLAYERS_SOCIAL_LEADERBOARD_BY_VERSION_IF_EXISTS",
    "data": {
        "leaderboardId": "default",
        "profileIds": [
            "profile-id",
            "another-profile-id"
        ],
        "versionId": 1
    }
}

JSON Response

{
    "status": 200,
    "data": {
        "leaderboardId": "general",
        "timeBeforeReset": 3358262,
        "leaderboard": [
            {
                "updatedAt": 1462825797845,
                "pictureUrl": null,
                "playerName": "Peter",
                "playerId": "ee8cad26-16f2-4ef8-9045-3aab84ce6362",
                "createdAt": 1462825797845,
                "data": {
                    "nickname": "pete"
                },
                "score": 100,
                "summaryFriendData": null
            },
            {
                "updatedAt": 1462825730011,
                "pictureUrl": null,
                "playerName": "Billy",
                "playerId": "295c510f-507f-4bcf-80e1-ebc73708ec3c",
                "createdAt": 1462825730011,
                "data": {
                    "nickname": "bill"
                },
                "score": 10,
                "summaryFriendData": null
            }
        ],
        "server_time": 1462825845567
    }
}