EditLeaderboard

caution

WARNING: This call, EditLeaderboard(), will be deprecated and replaced with SysEditLeaderboard().

Edits a existing leaderboard under the context of the current game. You can optionally send a user-defined json string of data with the edit leaderboard. This string could include information relevant to the edited leaderboard.

Service	Operation
leaderboard	EDIT_LEADERBOARD

Method Parameters

Parameter	Description
leaderboardId	The leaderboard to edit
data	Optional user-defined data to relevant to the edited leaderboard
leaderboardType	Leaderboard type
rotationType	Type of rotation
rotationReset	Date to start the rotation (date in millis)
retainedCount	How many previous rotations to keep
numDaysToRotate	Optional parameter for use only with DAYS rotation type

Usage

http://localhost:3000

C#

//cloud code only

C++

//cloud code only

Obj-C

//cloud code only

Java

//cloud code only

JavaScript

//cloud code only

Dart

// Cloud Code only. To view example, switch to the Cloud Code tab

Roblox

// N/A

GDScript

N/A

Cloud Code

var leaderboardId = "testEdit";
var type = "HIGH_VALUE";
var rotationType = "WEEKLY";
var rotationReset = Date.now();
var versionsToRetain = 6;
var data = { "test": 1234 };

var leaderboardProxy = bridge.getLeaderboardServiceProxy();
var retVal = leaderboardProxy.editLeaderboard(
    leaderboardId,
    type,
    rotationType,
    rotationReset,
    versionsToRetain,
    data
);

// For DAYS rotation type

var leaderboardId = "testEdit";
var type = "HIGH_VALUE";
var rotationType = "DAYS";
var rotationReset = Date.now();
var versionsToRetain = 6;
var data = { "test": 1234 };
var numDaysToRotate = 3;

var leaderboardProxy = bridge.getLeaderboardServiceProxy();
var retVal = leaderboardProxy.editLeaderboard(
    leaderboardId,
    type,
    rotationType,
    rotationReset,
    versionsToRetain,
    data,
    numDaysToRotate
);

Raw

{
    "service": "leaderboard",
    "operation": "EDIT_LEADERBOARD",
    "data": {
        "leaderboardId": "default",
        "leaderboardType": "HIGH_VALUE",
        "rotationType": "DAYS",
        "rotationResetTime": "[[#ts+60000]]",
        "retainedCount": 2,
        "numDaysToRotate": 5,
        "data": {
            "street": "1309 Carling Avenue"
        }
    }
}

JSON Response

{
    "status": 200,
    "data": null
}

Common Error Code

Status Codes

Code	Name	Description
40499	NO_LEADERBOARD_FOUND	No leaderboard with given leaderboardId