GetGlobalLeaderboardViewByVersionIfExists

Method returns a view of global leaderboard results that centers on the current player, if the leaderboard exists. By using a non-current version id, the user can retrieve a historical leaderboard. Silently fails, if leaderboard does not exist, just returns null and success, instead of an error.

See GetGlobalLeaderboardVersions method to retrieve the version ID.

Service	Operation
leaderboard	GET_GLOBAL_LEADERBOARD_VIEW_BY_VERSION_IF_EXISTS

Method Parameters

Parameter	Description
leaderboardId	The id of the leaderboard.
sortOrder	Sort order of page. ("HIGH_TO_LOW" or "LOW_TO_HIGH")
beforeCount	The count of number of players before the current player to include.
afterCount	The count of number of players after the current player to include.
versionId	The historical version to retrieve.

Usage

http://localhost:3000

C#

string leaderboardId = "default";
SortOrder sortOrder = BrainCloudSocialLeaderboard.SortOrder.HIGH_TO_LOW;
int beforeCount = 3;
int afterCount = 4;
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.GetGlobalLeaderboardViewByVersionIfExists(leaderboardId, sortOrder, beforeCount, afterCount, versionId, successCallback, failureCallback);

C++

const char *leaderboardId = "default";
SortOrder sortOrder = HIGH_TO_LOW;
int beforeCount = 3;
int afterCount = 4;
int versionId = -1;
_bc->getLeaderboardService()->getGlobalLeaderboardViewByVersionIfExists(leaderboardId, sortOrder, beforeCount, afterCount, versionId, this);

Objective-C

NSString *leaderboardId = @"default";
SortOrder sortOrder = HIGH_TO_LOW;
int beforeCount = 3;
int afterCount = 4;
int versionId = -1;
BCCompletionBlock successBlock;      // define callback
BCErrorCompletionBlock failureBlock; // define callback

[[_bc leaderboardService] getGlobalLeaderboardViewByVersionIfExists:leaderboardId
                  sortOrder:sortOrder
                beforeCount:beforeCount
                 afterCount:afterCount
                  versionId:versionId
            completionBlock:successBlock
       errorCompletionBlock:failureBlock
                   cbObject:nil];

Java

String leaderboardId = "default";
SortOrder sortOrder = BrainCloudSocialLeaderboardService.SortOrder.HIGH_TO_LOW;
int beforeCount = 3;
int afterCount = 4;
int versionId = -1;
this; // implements IServerCallback

_bc.getLeaderboardService().getGlobalLeaderboardViewByVersionIfExists(leaderboardId, sortOrder, beforeCount, afterCount, 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 sortOrder = "HIGH_TO_LOW";
var beforeCount = 3;
var afterCount = 4;
var versionId = -1;

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

Dart

var  leaderboardId = "default";
var  sortOrder = SortOrder.HIGH_TO_LOW;
var  beforeCount = 3;
var  afterCount = 4;
var  versionId = -1;

ServerResponse result = await _bc.leaderboardService.getGlobalLeaderboardViewByVersionIfExists(leaderboardId:leaderboardId, sortOrder:sortOrder, beforeCount:beforeCount, afterCount:afterCount, versionId:versionId);

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

Cloud Code

var leaderboardId = "default";
var versionId = -1;
var beforeCount = 3;
var afterCount = 4;
var leaderboardProxy = bridge.getLeaderboardServiceProxy();

var postResult = leaderboardProxy.getGlobalLeaderboardViewByVersionIfExists(leaderboardId, versionId, sortOrder, beforeCount, afterCount);
if (postResult.status == 200) {
    // Success!
}

Raw

{
    "service": "leaderboard",
    "operation": "GET_GLOBAL_LEADERBOARD_VIEW_BY_VERSION_IF_EXISTS",
    "data": {
        "leaderboardId": "default",
        "sort": "HIGH_TO_LOW",
        "beforeCount": 3,
        "afterCount": 4,
        "versionId": -1
    }
}

JSON Response

{
    "status": 200,
    "data": {
        "leaderboardId": "abc",
        "moreBefore": false,
        "timeBeforeReset": 48085996,
        "leaderboard": [
            {
                "playerId": "8c86f306-73ea-4536-9c92-aba086064d2c",
                "score": 10,
                "data": {
                    "nickname": "batman"
                },
                "createdAt": 1433863814394,
                "updatedAt": 1433863814394,
                "index": 0,
                "rank": 1,
                "name": "",
                "summaryFriendData": {
                    "xp": 12,
                    "favColour": "red"
                },
                "pictureUrl": null
            },
            {
                "playerId": "ab21c0af-9d3e-4a81-b3c8-ddc1fb77d9a1",
                "score": 8,
                "data": {
                    "nickname": "robin"
                },
                "createdAt": 1433864253221,
                "updatedAt": 1433864253221,
                "index": 1,
                "rank": 2,
                "name": "",
                "summaryFriendData": null,
                "pictureUrl": null
            }
        ],
        "server_time": 1433864314004,
        "moreAfter": false
    }
}