RemovePlayerScore

Removes a player's score from the leaderboard.

Service	Operation
leaderboard	REMOVE_PLAYER_SCORE

Method Parameters

Parameter	Description
leaderboardId	The leaderboard to post to.
versionId	The version of the leaderboard. Use -1 to specify the currently active leaderboard version.

Usage

http://localhost:3000

C#

string leaderboardId = "default";
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.RemovePlayerScore(leaderboardId, versionId, successCallback, failureCallback);

C++

const char *leaderboardId = "default";
int versionId = -1;
_bc->getLeaderboardService()->removePlayerScore(leaderboardId, versionId, this);

Objective-C

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

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

Java

String leaderboardId = "default";
int versionId = -1;
this; // implements IServerCallback

_bc.getLeaderboardService().removePlayerScore(leaderboardId, 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 versionId = -1;

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

Dart

var  leaderboardId = "default";
var  versionId = -1;

ServerResponse result = await _bc.leaderboardService.removePlayerScore(leaderboardId:leaderboardId, 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 leaderboardProxy = bridge.getLeaderboardServiceProxy();

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

Raw

{
    "service": "leaderboard",
    "operation": "REMOVE_PLAYER_SCORE",
    "data": {
        "leaderboardId": "default",
        "versionId": -1
    }
}

JSON Response

{
    "status": 200,
    "data": {
        "numScoresRemoved": 1
    }
}