Data interface for retrieving player information.
Nested Class Summary
Constant Summary
| long | CURRENT_XP_UNKNOWN | Constant indicating that the current XP total for a player is not known. |
| long | TIMESTAMP_UNKNOWN | Constant indicating that a timestamp for a player is not known. |
Inherited Constant Summary
Public Method Summary
| abstract Uri | |
| abstract Uri | |
| abstract CurrentPlayerInfo | |
| abstract void | |
| abstract String | |
| abstract Uri | |
| abstract Uri | |
| abstract long | getLastPlayedWithTimestamp
()
This method is deprecated. Real-time multiplayer and Turn-based multiplayer
support is being shut down on March 31, 2020. See Multiplayer
deprecation
|
| abstract PlayerLevelInfo | |
| abstract String | |
| abstract PlayerRelationshipInfo | |
| abstract long | getRetrievedTimestamp
()
Retrieves the timestamp at which this player record was last updated locally.
|
| abstract String | |
| abstract void | |
| abstract boolean | |
| abstract boolean |
Inherited Method Summary
Constants
public static final long CURRENT_XP_UNKNOWN
Constant indicating that the current XP total for a player is not known.
public static final long TIMESTAMP_UNKNOWN
Constant indicating that a timestamp for a player is not known.
Public Methods
public abstract Uri getBannerImageLandscapeUri ()
Retrieves the URI for loading this player's landscape banner image. Returns null if the player has no landscape banner image.
To retrieve the Image from the Uri
, use ImageManager
.
Returns
- The image URI for the player's landscape banner image, or null if the player has none.
public abstract Uri getBannerImagePortraitUri ()
Retrieves the URI for loading this player's portrait banner image. Returns null if the player has no portrait banner image.
To retrieve the Image from the Uri
, use ImageManager
.
Returns
- The image URI for the player's portrait banner image, or null if the player has none.
public abstract CurrentPlayerInfo getCurrentPlayerInfo ()
Returns information only available for the signed-in user. The method will return null
for other players.
public abstract void getDisplayName ( CharArrayBuffer dataOut)
Loads the player's display name into the given CharArrayBuffer
.
Parameters
public abstract String getDisplayName ()
Retrieves the display name for this player.
Returns
- The player's display name.
public abstract Uri getHiResImageUri ()
Retrieves the URI for loading this player's hi-res profile image. Returns null if the player has no profile image.
To retrieve the Image from the Uri
, use ImageManager
.
Returns
- The image URI for the player's hi-res profile image, or null if the player has none.
public abstract Uri getIconImageUri ()
Retrieves the URI for loading this player's icon-size profile image. Returns null if the player has no profile image.
To retrieve the Image from the Uri
, use ImageManager
.
Returns
- The image URI for the player's icon-size profile image, or null if the player has none.
public abstract long getLastPlayedWithTimestamp ()
This method is deprecated.
Real-time multiplayer and Turn-based multiplayer support is being shut down on March 31,
2020. See Multiplayer
deprecation
Retrieves the timestamp at which this player last played a multiplayer game with the
currently signed in user. If the timestamp is not found, this method returns TIMESTAMP_UNKNOWN
.
Returns
- The timestamp (in ms since epoch) at which the player last played a multiplayer game with the currently signed in user.
public abstract PlayerLevelInfo getLevelInfo ()
Retrieves the player level associated information if any exists. If no level
information exists for this player, this method will return null
.
Returns
- The
PlayerLevelInfoassociated with this player, if any.
public abstract String getPlayerId ()
Retrieves the ID of this player.
Returns
- The player ID.
public abstract PlayerRelationshipInfo getRelationshipInfo ()
Returns relationship information of this player. If no relationship information
exists for this player, this method will return null
.
public abstract long getRetrievedTimestamp ()
Retrieves the timestamp at which this player record was last updated locally.
Returns
- The timestamp (in ms since epoch) at which the player data was last updated locally.
public abstract String getTitle ()
Retrieves the title of the player. This is based on the player's gameplay activity in apps using Google Play Games services. Note that not all players have titles, and that a player's title may change over time.
Returns
- The player's title, or
nullif this player has no title.
public abstract void getTitle ( CharArrayBuffer dataOut)
Loads the player's title into the given CharArrayBuffer
.
Parameters
public abstract boolean hasHiResImage ()
Indicates whether this player has a hi-res profile image to display.
Returns
- Whether the player has a hi-res profile image to display.
public abstract boolean hasIconImage ()
Indicates whether this player has an icon-size profile image to display.
Returns
- Whether the player has an icon-size profile image to display.
