com.google.api.services.games.model

Class PlayerLeaderboardScore

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.games.model.PlayerLeaderboardScore

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class PlayerLeaderboardScore
extends com.google.api.client.json.GenericJson

A player leaderboard score object.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Play Games Services API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
PlayerLeaderboardScore()

Method Summary

Modifier and Type	Method and Description
PlayerLeaderboardScore	clone()
LeaderboardScoreRank	getFriendsRank() The rank of the score in the friends collection for this leaderboard.
String	getKind() Uniquely identifies the type of this resource.
String	getLeaderboardId() The ID of the leaderboard this score is in.
LeaderboardScoreRank	getPublicRank() The public rank of the score in this leaderboard.
String	getScoreString() The formatted value of this score.
String	getScoreTag() Additional information about the score.
Long	getScoreValue() The numerical value of this score.
LeaderboardScoreRank	getSocialRank() The social rank of the score in this leaderboard.
String	getTimeSpan() The time span of this score.
Long	getWriteTimestamp() The timestamp at which this score was recorded, in milliseconds since the epoch in UTC.
PlayerLeaderboardScore	set(String fieldName, Object value)
PlayerLeaderboardScore	setFriendsRank(LeaderboardScoreRank friendsRank) The rank of the score in the friends collection for this leaderboard.
PlayerLeaderboardScore	setKind(String kind) Uniquely identifies the type of this resource.
PlayerLeaderboardScore	setLeaderboardId(String leaderboardId) The ID of the leaderboard this score is in.
PlayerLeaderboardScore	setPublicRank(LeaderboardScoreRank publicRank) The public rank of the score in this leaderboard.
PlayerLeaderboardScore	setScoreString(String scoreString) The formatted value of this score.
PlayerLeaderboardScore	setScoreTag(String scoreTag) Additional information about the score.
PlayerLeaderboardScore	setScoreValue(Long scoreValue) The numerical value of this score.
PlayerLeaderboardScore	setSocialRank(LeaderboardScoreRank socialRank) The social rank of the score in this leaderboard.
PlayerLeaderboardScore	setTimeSpan(String timeSpan) The time span of this score.
PlayerLeaderboardScore	setWriteTimestamp(Long writeTimestamp) The timestamp at which this score was recorded, in milliseconds since the epoch in UTC.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

PlayerLeaderboardScore

public PlayerLeaderboardScore()

Method Detail

getFriendsRank

public LeaderboardScoreRank getFriendsRank()

The rank of the score in the friends collection for this leaderboard.

Returns:

value or null for none

setFriendsRank

public PlayerLeaderboardScore setFriendsRank(LeaderboardScoreRank friendsRank)

The rank of the score in the friends collection for this leaderboard.

Parameters:

friendsRank - friendsRank or null for none

getKind

public String getKind()

Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLeaderboardScore`.

Returns:

value or null for none

setKind

public PlayerLeaderboardScore setKind(String kind)

Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLeaderboardScore`.

Parameters:

kind - kind or null for none

getLeaderboardId

public String getLeaderboardId()

The ID of the leaderboard this score is in.

Returns:

value or null for none

setLeaderboardId

public PlayerLeaderboardScore setLeaderboardId(String leaderboardId)

The ID of the leaderboard this score is in.

Parameters:

leaderboardId - leaderboardId or null for none

getPublicRank

public LeaderboardScoreRank getPublicRank()

The public rank of the score in this leaderboard. This object will not be present if the user is not sharing their scores publicly.

Returns:

value or null for none

setPublicRank

public PlayerLeaderboardScore setPublicRank(LeaderboardScoreRank publicRank)

The public rank of the score in this leaderboard. This object will not be present if the user is not sharing their scores publicly.

Parameters:

publicRank - publicRank or null for none

getScoreString

public String getScoreString()

The formatted value of this score.

Returns:

value or null for none

setScoreString

public PlayerLeaderboardScore setScoreString(String scoreString)

The formatted value of this score.

Parameters:

scoreString - scoreString or null for none

getScoreTag

public String getScoreTag()

Additional information about the score. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.

Returns:

value or null for none

setScoreTag

public PlayerLeaderboardScore setScoreTag(String scoreTag)

Additional information about the score. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.

Parameters:

scoreTag - scoreTag or null for none

getScoreValue

public Long getScoreValue()

The numerical value of this score.

Returns:

value or null for none

setScoreValue

public PlayerLeaderboardScore setScoreValue(Long scoreValue)

The numerical value of this score.

Parameters:

scoreValue - scoreValue or null for none

getSocialRank

public LeaderboardScoreRank getSocialRank()

The social rank of the score in this leaderboard.

Returns:

value or null for none

setSocialRank

public PlayerLeaderboardScore setSocialRank(LeaderboardScoreRank socialRank)

The social rank of the score in this leaderboard.

Parameters:

socialRank - socialRank or null for none

getTimeSpan

public String getTimeSpan()

The time span of this score.

Returns:

value or null for none

setTimeSpan

public PlayerLeaderboardScore setTimeSpan(String timeSpan)

The time span of this score.

Parameters:

timeSpan - timeSpan or null for none

getWriteTimestamp

public Long getWriteTimestamp()

The timestamp at which this score was recorded, in milliseconds since the epoch in UTC.

Returns:

value or null for none

setWriteTimestamp

public PlayerLeaderboardScore setWriteTimestamp(Long writeTimestamp)

The timestamp at which this score was recorded, in milliseconds since the epoch in UTC.

Parameters:

writeTimestamp - writeTimestamp or null for none

set

public PlayerLeaderboardScore set(String fieldName,
                                  Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public PlayerLeaderboardScore clone()

Overrides:

clone in class com.google.api.client.json.GenericJson