Scoreflex Javascript SDK

Class: Leaderboard

Scoreflex.SDK. Leaderboard

new Leaderboard(leaderboardId)

Leaderboard instance object.

Parameters:
Name Type Description
leaderboardId string

Leaderboard ID
Source:

Methods

getId() → {string}

Return the leaderboard identifier (leaderboardId).

Source:
Returns:

Leaderboard ID

Type
string

show(parameters, options)

Display a web client for the requested leaderboard.

Parameters:
Name Type Description
parameters object

key/value pair of query string parameters
options object

key/value pair of WebClient options
Source:

showOverview(parameters, options)

Display a web client for the requested leaderboard overview.

Parameters:
Name Type Description
parameters object

key/value pair of query string parameters
options object

key/value pair of WebClient options
Source:

showRankbox(parameters, options)

Display a web client with the current player's score for the requested leaderboard.

Parameters:
Name Type Description
parameters object

(facultative, the last score of the player} 'score':{int}
options object

key/value pair of WebClient options
Source:

submitScore(score, parameters, handlers)

Send a score to a leaderboard.

Parameters:
Name Type Description
score int

raw score
parameters object

key/value pair of query string parameters
handlers module:Scoreflex.SDK.Handlers

request callbacks
Source:

submitScoreAndShowRankbox(score, parameters, options)

Put a score and show the rankbox. The rankbox takes into account the score.

Parameters:
Name Type Description
score int

raw score
parameters object

key/value pair of query string parameters
options object

key/value pair of WebClient options
Source: