com.google.android.gms.games.leaderboard.Leaderboards |
This interface is deprecated.
Use LeaderboardsClient
instead
Entry point for leaderboard functionality.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Leaderboards.LeaderboardMetadataResult |
This interface is deprecated.
LeaderboardBuffer is returned directly in the LeaderboardsClient .
|
||||||||||
Leaderboards.LoadPlayerScoreResult |
This interface is deprecated.
LeaderboardScore is returned directly in the LeaderboardsClient .
|
||||||||||
Leaderboards.LoadScoresResult |
This interface is deprecated.
LeaderboardsClient.LeaderboardScores is
returned directly in the LeaderboardsClient .
|
||||||||||
Leaderboards.SubmitScoreResult |
This interface is deprecated.
ScoreSubmissionData is returned directly in the LeaderboardsClient .
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Gets an intent to show the list of leaderboards for a game.
| |||||||||||
Gets an intent to show a leaderboard for a game.
| |||||||||||
Gets an intent to show a leaderboard for a game.
| |||||||||||
Gets an intent to show a leaderboard for a game.
| |||||||||||
Asynchronously load the currently signed in player's score for a given leaderboard.
| |||||||||||
Asynchronously load a specific leaderboard's metadata for this game.
| |||||||||||
Asynchronously load the list of leaderboard metadata for this game.
| |||||||||||
Asynchronously loads an additional page of score data for the given score buffer.
| |||||||||||
Asynchronously load the player-centered page of scores for a given leaderboard.
| |||||||||||
Asynchronously load the player-centered page of scores for a given leaderboard.
| |||||||||||
Asynchronously load the top page of scores for a given leaderboard.
| |||||||||||
Asynchronously load the top page of scores for a given leaderboard.
| |||||||||||
Submit a score to a leaderboard for the currently signed in player.
| |||||||||||
Submit a score to a leaderboard for the currently signed in player.
| |||||||||||
Submit a score to a leaderboard for the currently signed in player.
| |||||||||||
Submit a score to a leaderboard for the currently signed in player.
|
Gets an intent to show the list of leaderboards for a game. Note that this must be invoked with
startActivityForResult(Intent, int)
, so that the identity of the calling
package can be established.
A RESULT_RECONNECT_REQUIRED
may be returned as the resultCode in onActivityResult(int, int, Intent)
if the GoogleApiClient
ends up in an inconsistent state.
Required API: API
Required Scopes: SCOPE_GAMES
Parameters | |
---|---|
apiClient |
GoogleApiClient : The GoogleApiClient to service the call. |
Returns | |
---|---|
Intent |
An Intent that can be started to view the list of leaderboards for a game.
|
Gets an intent to show a leaderboard for a game. Note that this must be invoked with startActivityForResult(Intent, int)
, so that the identity of the calling package can
be established.
A RESULT_RECONNECT_REQUIRED
may be returned as the resultCode in onActivityResult(int, int, Intent)
if the GoogleApiClient
ends up in an inconsistent state.
Required API: API
Required Scopes: SCOPE_GAMES
Parameters | |
---|---|
apiClient |
GoogleApiClient : The GoogleApiClient to service the call. |
leaderboardId |
String : The ID of the leaderboard to view. |
Returns | |
---|---|
Intent |
An Intent that can be started to view the specified leaderboard.
|
Gets an intent to show a leaderboard for a game. Note that this must be invoked with startActivityForResult(Intent, int)
, so that the identity of the calling package can
be established.
A RESULT_RECONNECT_REQUIRED
may be returned as the resultCode in onActivityResult(int, int, Intent)
if the GoogleApiClient
ends up in an inconsistent state.
Required API: API
Required Scopes: SCOPE_GAMES
Parameters | |
---|---|
apiClient |
GoogleApiClient : The GoogleApiClient to service the call. |
leaderboardId |
String : The ID of the leaderboard to view. |
timeSpan |
int : Time span to retrieve data for. Valid values are TIME_SPAN_DAILY , TIME_SPAN_WEEKLY , or TIME_SPAN_ALL_TIME . |
Returns | |
---|---|
Intent |
An Intent that can be started to view the specified leaderboard.
|
Gets an intent to show a leaderboard for a game. Note that this must be invoked with startActivityForResult(Intent, int)
, so that the identity of the calling package can
be established.
A RESULT_RECONNECT_REQUIRED
may be returned as the resultCode in onActivityResult(int, int, Intent)
if the GoogleApiClient
ends up in an inconsistent state.
Required API: API
Required Scopes: SCOPE_GAMES
Parameters | |
---|---|
apiClient |
GoogleApiClient : The GoogleApiClient to service the call. |
leaderboardId |
String : The ID of the leaderboard to view. |
timeSpan |
int : Time span to retrieve data for. Valid values are TIME_SPAN_DAILY , TIME_SPAN_WEEKLY , or TIME_SPAN_ALL_TIME . |
collection |
int : The collection to show by default. Valid values are COLLECTION_PUBLIC or COLLECTION_SOCIAL . |
Returns | |
---|---|
Intent |
An Intent that can be started to view the specified leaderboard.
|
Asynchronously load the currently signed in player's score for a given leaderboard.
Required API: API
Required Scopes: SCOPE_GAMES
Parameters | |
---|---|
apiClient |
GoogleApiClient : The GoogleApiClient to service the call. |
leaderboardId |
String : ID of the leaderboard to load the score from. |
span |
int : Time span to retrieve data for. Valid values are TIME_SPAN_DAILY , TIME_SPAN_WEEKLY , or TIME_SPAN_ALL_TIME . |
leaderboardCollection |
int : The leaderboard collection to retrieve scores for. Valid values
are either COLLECTION_PUBLIC or COLLECTION_SOCIAL . |
Returns | |
---|---|
PendingResult<Leaderboards.LoadPlayerScoreResult> |
PendingResult to access the data when available.
|
Asynchronously load a specific leaderboard's metadata for this game.
Required API: API
Required Scopes: SCOPE_GAMES
Parameters | |
---|---|
apiClient |
GoogleApiClient : The GoogleApiClient to service the call. |
leaderboardId |
String : ID of the leaderboard to load metadata for. |
forceReload |
boolean : If true , this call will clear any locally cached data and attempt to
fetch the latest data from the server. This would commonly be used for something like a
user-initiated refresh. Normally, this should be set to false to gain advantages of
data caching. |
Returns | |
---|---|
PendingResult<Leaderboards.LeaderboardMetadataResult> |
PendingResult to access the data when available.
|
Asynchronously load the list of leaderboard metadata for this game.
Required API: API
Required Scopes: SCOPE_GAMES
Parameters | |
---|---|
apiClient |
GoogleApiClient : The GoogleApiClient to service the call. |
forceReload |
boolean : If true , this call will clear any locally cached data and attempt to
fetch the latest data from the server. This would commonly be used for something like a
user-initiated refresh. Normally, this should be set to false to gain advantages of
data caching. |
Returns | |
---|---|
PendingResult<Leaderboards.LeaderboardMetadataResult> |
PendingResult to access the data when available.
|
Asynchronously loads an additional page of score data for the given score buffer. A new score buffer will be delivered that replaces the given buffer.
Required API: API
Required Scopes: SCOPE_GAMES
Parameters | |
---|---|
apiClient |
GoogleApiClient : The GoogleApiClient to service the call. |
buffer |
LeaderboardScoreBuffer : The existing buffer that will be expanded. The buffer is allowed to be closed
prior to being passed in to this method. |
maxResults |
int : The maximum number of scores to fetch per page. Must be between 1 and 25.
Note that the number of scores returned here may be greater than this value, depending on
how much data is cached on the device. |
pageDirection |
int : The direction to expand the buffer. Values are defined in PageDirection . |
Returns | |
---|---|
PendingResult<Leaderboards.LoadScoresResult> |
PendingResult to access the data when available.
|
Asynchronously load the player-centered page of scores for a given leaderboard. If the player does not have a score on this leaderboard, this call will return the top page instead.
Required API: API
Required Scopes: SCOPE_GAMES
Parameters | |
---|---|
apiClient |
GoogleApiClient : The GoogleApiClient to service the call. |
leaderboardId |
String : ID of the leaderboard. |
span |
int : Time span to retrieve data for. Valid values are TIME_SPAN_DAILY , TIME_SPAN_WEEKLY , or TIME_SPAN_ALL_TIME . |
leaderboardCollection |
int : The leaderboard collection to retrieve scores for. Valid values
are either COLLECTION_PUBLIC or COLLECTION_SOCIAL . |
maxResults |
int : The maximum number of scores to fetch per page. Must be between 1 and 25. |
Returns | |
---|---|
PendingResult<Leaderboards.LoadScoresResult> |
PendingResult to access the data when available.
|
Asynchronously load the player-centered page of scores for a given leaderboard. If the player does not have a score on this leaderboard, this call will return the top page instead.
Required API: API
Required Scopes: SCOPE_GAMES
Parameters | |
---|---|
apiClient |
GoogleApiClient : The GoogleApiClient to service the call. |
leaderboardId |
String : ID of the leaderboard. |
span |
int : Time span to retrieve data for. Valid values are TIME_SPAN_DAILY , TIME_SPAN_WEEKLY , or TIME_SPAN_ALL_TIME . |
leaderboardCollection |
int : The leaderboard collection to retrieve scores for. Valid values
are either COLLECTION_PUBLIC or COLLECTION_SOCIAL . |
maxResults |
int : The maximum number of scores to fetch per page. Must be between 1 and 25. |
forceReload |
boolean : If true , this call will clear any locally cached data and attempt to
fetch the latest data from the server. This would commonly be used for something like a
user-initiated refresh. Normally, this should be set to false to gain advantages of
data caching. |
Returns | |
---|---|
PendingResult<Leaderboards.LoadScoresResult> |
PendingResult to access the data when available.
|
Asynchronously load the top page of scores for a given leaderboard.
Required API: API
Required Scopes: SCOPE_GAMES
Parameters | |
---|---|
apiClient |
GoogleApiClient : The GoogleApiClient to service the call. |
leaderboardId |
String : ID of the leaderboard. |
span |
int : Time span to retrieve data for. Valid values are TIME_SPAN_DAILY , TIME_SPAN_WEEKLY , or TIME_SPAN_ALL_TIME . |
leaderboardCollection |
int : The leaderboard collection to retrieve scores for. Valid values
are either COLLECTION_PUBLIC or COLLECTION_SOCIAL . |
maxResults |
int : The maximum number of scores to fetch per page. Must be between 1 and 25. |
forceReload |
boolean : If true , this call will clear any locally cached data and attempt to
fetch the latest data from the server. This would commonly be used for something like a
user-initiated refresh. Normally, this should be set to false to gain advantages of
data caching. |
Returns | |
---|---|
PendingResult<Leaderboards.LoadScoresResult> |
PendingResult to access the data when available.
|
Asynchronously load the top page of scores for a given leaderboard.
Required API: API
Required Scopes: SCOPE_GAMES
Parameters | |
---|---|
apiClient |
GoogleApiClient : The GoogleApiClient to service the call. |
leaderboardId |
String : ID of the leaderboard. |
span |
int : Time span to retrieve data for. Valid values are TIME_SPAN_DAILY , TIME_SPAN_WEEKLY , or TIME_SPAN_ALL_TIME . |
leaderboardCollection |
int : The leaderboard collection to retrieve scores for. Valid values
are either COLLECTION_PUBLIC or COLLECTION_SOCIAL . |
maxResults |
int : The maximum number of scores to fetch per page. Must be between 1 and 25. |
Returns | |
---|---|
PendingResult<Leaderboards.LoadScoresResult> |
PendingResult to access the data when available.
|
Submit a score to a leaderboard for the currently signed in player. The score is ignored if it is worse (as defined by the leaderboard configuration) than a previously submitted score for the same player.
This form of the API is a fire-and-forget form. Use this if you do not need to be notified of the results of submitting the score, though note that the update may not be sent to the server until the next sync.
The meaning of the score value depends on the formatting of the leaderboard established in the developer console. Leaderboards support the following score formats:
score
represents a raw value, and will be formatted based on the
number of decimal places configured. A score of 1000 would be formatted as 1000, 100.0,
or 10.00 for 0, 1, or 2 decimal places.
score
represents an elapsed time in milliseconds. The value will be
formatted as an appropriate time value.
score
represents a value in micro units. For example, in USD, a score
of 100 would display as $0.0001, while a score of 1000000 would display as $1.00
For more details, please see Leaderboard Concepts.
Required API: API
Required Scopes: SCOPE_GAMES
Parameters | |
---|---|
apiClient |
GoogleApiClient : The GoogleApiClient to service the call. |
leaderboardId |
String : The leaderboard to submit the score to. |
score |
long : The raw score value.
|
Submit a score to a leaderboard for the currently signed in player. The score is ignored if it is worse (as defined by the leaderboard configuration) than a previously submitted score for the same player.
This form of the API is a fire-and-forget form. Use this if you do not need to be notified of the results of submitting the score, though note that the update may not be sent to the server until the next sync.
The meaning of the score value depends on the formatting of the leaderboard established in the developer console. Leaderboards support the following score formats:
score
represents a raw value, and will be formatted based on the
number of decimal places configured. A score of 1000 would be formatted as 1000, 100.0,
or 10.00 for 0, 1, or 2 decimal places.
score
represents an elapsed time in milliseconds. The value will be
formatted as an appropriate time value.
score
represents a value in micro units. For example, in USD, a score
of 100 would display as $0.0001, while a score of 1000000 would display as $1.00
For more details, please see Leaderboard Concepts.
Required API: API
Required Scopes: SCOPE_GAMES
Parameters | |
---|---|
apiClient |
GoogleApiClient : The GoogleApiClient to service the call. |
leaderboardId |
String : The leaderboard to submit the score to. |
score |
long : The raw score value. |
scoreTag |
String : Optional metadata about this score. The value may contain no more than 64
URI-safe characters as defined by section 2.3 of RFC 3986.
|
Submit a score to a leaderboard for the currently signed in player. The score is ignored if it is worse (as defined by the leaderboard configuration) than a previously submitted score for the same player.
This form of the API will attempt to submit the score to the server immediately, and will return a GamesPendingResult with information about the submission.
The meaning of the score value depends on the formatting of the leaderboard established in the developer console. Leaderboards support the following score formats:
score
represents a raw value, and will be formatted based on the
number of decimal places configured. A score of 1000 would be formatted as 1000, 100.0,
or 10.00 for 0, 1, or 2 decimal places.
score
represents an elapsed time in milliseconds. The value will be
formatted as an appropriate time value.
score
represents a value in micro units. For example, in USD, a score
of 100 would display as $0.0001, while a score of 1000000 would display as $1.00
For more details, please see this page.
Required API: API
Required Scopes: SCOPE_GAMES
Parameters | |
---|---|
apiClient |
GoogleApiClient : The GoogleApiClient to service the call. |
leaderboardId |
String : The leaderboard to submit the score to. |
score |
long : The raw score value. |
scoreTag |
String : Optional metadata about this score. The value may contain no more than 64
URI-safe characters as defined by section 2.3 of RFC 3986. |
Returns | |
---|---|
PendingResult<Leaderboards.SubmitScoreResult> |
PendingResult to access the data when available.
|
Submit a score to a leaderboard for the currently signed in player. The score is ignored if it is worse (as defined by the leaderboard configuration) than a previously submitted score for the same player.
This form of the API will attempt to submit the score to the server immediately, and will return a GamesPendingResult with information about the submission.
The meaning of the score value depends on the formatting of the leaderboard established in the developer console. Leaderboards support the following score formats:
score
represents a raw value, and will be formatted based on the
number of decimal places configured. A score of 1000 would be formatted as 1000, 100.0,
or 10.00 for 0, 1, or 2 decimal places.
score
represents an elapsed time in milliseconds. The value will be
formatted as an appropriate time value.
score
represents a value in micro units. For example, in USD, a score
of 100 would display as $0.0001, while a score of 1000000 would display as $1.00
For more details, please see this page.
Required API: API
Required Scopes: SCOPE_GAMES
Parameters | |
---|---|
apiClient |
GoogleApiClient : The GoogleApiClient to service the call. |
leaderboardId |
String : The leaderboard to submit the score to. |
score |
long : The raw score value. |
Returns | |
---|---|
PendingResult<Leaderboards.SubmitScoreResult> |
PendingResult to access the data when available.
|