Page Summary
-
ScoreSubmissionData is a data object representing the result of submitting a score to a leaderboard.
-
It includes methods to retrieve the leaderboard ID and player ID associated with the score submission.
-
You can get the specific score result for a given time span using the
getScoreResultmethod. -
ScoreSubmissionData also contains a nested class,
ScoreSubmissionData.Result, which holds result data for a particular time span.
Data object representing the result of submitting a score to a leaderboard.
Nested Class Summary
| class | ScoreSubmissionData.Result | Simple data class containing the result data for a particular time span. | |
Public Method Summary
| String |
getLeaderboardId()
Retrieves the ID of the leaderboard the score was submitted to.
|
| String |
getPlayerId()
Retrieves the ID of the player the score was submitted for.
|
| ScoreSubmissionData.Result |
getScoreResult(int timeSpan)
Retrieves the
ScoreSubmissionData.Result object for the given time span, if any.
|
| String |
toString()
|
Inherited Method Summary
Public Methods
public String getLeaderboardId ()
Retrieves the ID of the leaderboard the score was submitted to.
Returns
- The ID of the leaderboard.
public String getPlayerId ()
Retrieves the ID of the player the score was submitted for.
Returns
- The ID of submitting player.
public ScoreSubmissionData.Result getScoreResult (int timeSpan)
Retrieves the
ScoreSubmissionData.Result object for the given time span, if any.
Parameters
| timeSpan | Time span to retrieve result for. Valid values are
LeaderboardVariant.TIME_SPAN_DAILY,
LeaderboardVariant.TIME_SPAN_WEEKLY, or
LeaderboardVariant.TIME_SPAN_ALL_TIME. |
|---|
Returns
- The appropriate
ScoreSubmissionData.Resultornullif no result was returned for the given time span.