Data interface for leaderboard metadata.
Constant Summary
int | SCORE_ORDER_LARGER_IS_BETTER | Score order constant for leaderboards where scores are sorted in descending order. |
int | SCORE_ORDER_SMALLER_IS_BETTER | Score order constant for leaderboards where scores are sorted in ascending order. |
Public Method Summary
abstractString |
getDisplayName()
Retrieves the display name of this leaderboard.
|
abstract void |
getDisplayName(CharArrayBuffer
dataOut)
Loads this leaderboard's display name into the given
CharArrayBuffer .
|
abstractUri |
getIconImageUri()
Retrieves an image URI that can be used to load this leaderboard's icon, or
null if there was a problem retrieving the icon.
|
abstractString |
getLeaderboardId()
Retrieves the ID of this leaderboard.
|
abstract int |
getScoreOrder()
Retrieves the sort order of scores for this leaderboard.
|
abstractArrayList<LeaderboardVariant> |
getVariants()
Retrieves the
LeaderboardVariant s for this leaderboard.
|
Inherited Method Summary
Constants
public static final int SCORE_ORDER_LARGER_IS_BETTER
Score order constant for leaderboards where scores are sorted in descending order.
public static final int SCORE_ORDER_SMALLER_IS_BETTER
Score order constant for leaderboards where scores are sorted in ascending order.
Public Methods
public abstractStringgetDisplayName()
Retrieves the display name of this leaderboard.
Returns
- Display name of this leaderboard.
public abstract voidgetDisplayName(CharArrayBuffer dataOut)
Loads this leaderboard's display name into the givenCharArrayBuffer
.
Parameters
dataOut | The buffer to load the data into. |
---|
public abstractUrigetIconImageUri()
Retrieves an image URI that can be used to load this leaderboard's icon, or null if there was a problem retrieving the icon.
To retrieve the Image from theUri
,use
ImageManager
.
Returns
- A URI that can be used to load this leaderboard's icon, or null if there was a problem retrieving the icon.
public abstractStringgetLeaderboardId()
Retrieves the ID of this leaderboard.
Returns
- The ID of this leaderboard.
public abstract intgetScoreOrder()
Retrieves the sort order of scores for this leaderboard. Possible values are
SCORE_ORDER_LARGER_IS_BETTER
or
SCORE_ORDER_SMALLER_IS_BETTER
.
Returns
- The score order used by this leaderboard.
public abstractArrayList<LeaderboardVariant> getVariants()
Retrieves the
LeaderboardVariant
s for this leaderboard. These will be returned sorted by
time span first, then by variant type.
Note that these variants are volatile, and are tied to the lifetime of the original buffer.
Returns
- A list containing the
LeaderboardVariant
s for this leaderboard.