public interface

Player

implements Freezable<Player> Parcelable
com.google.android.gms.games.Player
Known Indirect Subclasses

Class Overview

Data interface for retrieving player information.

Summary

Constants
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.
[Expand]
Inherited Constants
From interface android.os.Parcelable
Public Methods
abstract String getDisplayName()
Retrieves the display name for this player.
abstract void getDisplayName(CharArrayBuffer dataOut)
Loads the player's display name into the given CharArrayBuffer.
abstract Uri getHiResImageUri()
Retrieves the URI for loading this player's hi-res profile image.
abstract Uri getIconImageUri()
Retrieves the URI for loading this player's icon-size profile image.
abstract long getLastPlayedWithTimestamp()
Retrieves the timestamp at which this player last played a multiplayer game with the currently signed in user.
abstract PlayerLevelInfo getLevelInfo()
Retrieves the player level associated information if any exists.
abstract String getPlayerId()
Retrieves the ID of this player.
abstract long getRetrievedTimestamp()
Retrieves the timestamp at which this player record was last updated locally.
abstract void getTitle(CharArrayBuffer dataOut)
Loads the player's title into the given CharArrayBuffer.
abstract String getTitle()
Retrieves the title of the player.
abstract boolean hasHiResImage()
Indicates whether this player has a hi-res profile image to display.
abstract boolean hasIconImage()
Indicates whether this player has an icon-size profile image to display.
[Expand]
Inherited Methods
From interface com.google.android.gms.common.data.Freezable
From interface android.os.Parcelable

Constants

public static final long CURRENT_XP_UNKNOWN

Constant indicating that the current XP total for a player is not known.

Constant Value: -1 (0xffffffffffffffff)

public static final long TIMESTAMP_UNKNOWN

Constant indicating that a timestamp for a player is not known.

Constant Value: -1 (0xffffffffffffffff)

Public Methods

public abstract String getDisplayName ()

Retrieves the display name for this player.

Returns
  • The player's display name.

public abstract void getDisplayName (CharArrayBuffer dataOut)

Loads the player's display name into the given CharArrayBuffer.

Parameters
dataOut The buffer to load the data into.

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 ()

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

public abstract String getPlayerId ()

Retrieves the ID of this player.

Returns
  • The player ID.

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 void getTitle (CharArrayBuffer dataOut)

Loads the player's title into the given CharArrayBuffer.

Parameters
dataOut The buffer to load the data into.

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 null if this player has no title.

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.