PlayerEntity

  • PlayerEntity is an immutable data object representing player data, safe to cache or store, although the data may become stale.

  • This class is primarily for parceling Player data and should not be used directly.

  • PlayerEntity implements Parcelable and the Player interface, inheriting their constants and methods.

  • It provides methods to retrieve player details such as display name, player ID, various image URIs, level information, and relationship information.

  • There are utility methods to check for the presence of hi-res and icon-size profile images and to retrieve the timestamp of the last local update.

public final classPlayerEntity extendsObject
implementsParcelableParcelablePlayer

Data object representing a set of Player data. This is immutable, and therefore safe to cache or store. Note, however, that the data it represents may grow stale.

This class exists solely to support parceling these objects and should not be used directly.

Inherited Constant Summary

From interface android.os.Parcelable
intCONTENTS_FILE_DESCRIPTOR
intPARCELABLE_WRITE_RETURN_VALUE
From interfacecom.google.android.gms.games.Player
long CURRENT_XP_UNKNOWNConstant indicating that the current XP total for a player is not known.
long TIMESTAMP_UNKNOWNConstant indicating that a timestamp for a player is not known.

Field Summary

public static finalCreator<PlayerEntity>CREATOR

Public Method Summary

boolean
Player
Uri
getBannerImageLandscapeUri()
Retrieves the URI for loading this player's landscape banner image.
Uri
getBannerImagePortraitUri()
Retrieves the URI for loading this player's portrait banner image.
CurrentPlayerInfo
getCurrentPlayerInfo()
Returns information only available for the signed-in user.
void
getDisplayName(CharArrayBuffer dataOut)
Loads the player's display name into the givenCharArrayBuffer.
String
getDisplayName()
Retrieves the display name for this player.
Uri
getHiResImageUri()
Retrieves the URI for loading this player's hi-res profile image.
Uri
getIconImageUri()
Retrieves the URI for loading this player's icon-size profile image.
long
getLastPlayedWithTimestamp()
Retrieves the timestamp at which this player last played a multiplayer game with the currently signed in user.
PlayerLevelInfo
getLevelInfo()
Retrieves the player level associated information if any exists.
String
getPlayerId()
Retrieves the ID of this player.
PlayerRelationshipInfo
getRelationshipInfo()
Returns relationship information of this player.
long
getRetrievedTimestamp()
Retrieves the timestamp at which this player record was last updated locally.
String
getTitle()
Retrieves the title of the player.
void
getTitle(CharArrayBuffer dataOut)
Loads the player's title into the givenCharArrayBuffer.
boolean
hasHiResImage()
Indicates whether this player has a hi-res profile image to display.
boolean
hasIconImage()
Indicates whether this player has an icon-size profile image to display.
int
boolean
String
void
writeToParcel(Parcel dest, int flags)

Inherited Method Summary

From class java.lang.Object
Object
clone()
boolean
equals(Object arg0)
void
finalize()
finalClass<?>
getClass()
int
hashCode()
final void
notify()
final void
notifyAll()
String
toString()
final void
wait(long arg0, int arg1)
final void
wait(long arg0)
final void
wait()
From interface android.os.Parcelable
abstract int
describeContents()
abstract void
writeToParcel(Parcel arg0, int arg1)
From interfacecom.google.android.gms.games.Player
abstractUri
getBannerImageLandscapeUri()
Retrieves the URI for loading this player's landscape banner image.
abstractUri
getBannerImagePortraitUri()
Retrieves the URI for loading this player's portrait banner image.
abstractCurrentPlayerInfo
getCurrentPlayerInfo()
Returns information only available for the signed-in user.
abstract void
getDisplayName(CharArrayBuffer dataOut)
Loads the player's display name into the given CharArrayBuffer.
abstractString
getDisplayName()
Retrieves the display name for this player.
abstractUri
getHiResImageUri()
Retrieves the URI for loading this player's hi-res profile image.
abstractUri
getIconImageUri()
Retrieves the URI for loading this player's icon-size profile image.
abstract long
getLastPlayedWithTimestamp()
This method is deprecated. Real-time multiplayer and Turn-based multiplayer support is being shut down on March 31, 2020. SeeMultiplayer deprecation
abstractPlayerLevelInfo
getLevelInfo()
Retrieves the player level associated information if any exists.
abstractString
getPlayerId()
Retrieves the ID of this player.
abstract PlayerRelationshipInfo
getRelationshipInfo()
Returns relationship information of this player.
abstract long
getRetrievedTimestamp()
Retrieves the timestamp at which this player record was last updated locally.
abstractString
getTitle()
Retrieves the title of the player.
abstract void
getTitle(CharArrayBuffer dataOut)
Loads the player's title into the given CharArrayBuffer.
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.
From interface com.google.android.gms.common.data.Freezable
abstractPlayer
freeze()
abstract boolean
isDataValid()

Fields

public static finalCreator<PlayerEntity>CREATOR

Public Methods

public booleanequals(Object obj)

publicPlayerfreeze()

publicUrigetBannerImageLandscapeUri()

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 theUri, useImageManager.

Returns
  • The image URI for the player's landscape banner image, or null if the player has none.

publicUrigetBannerImagePortraitUri()

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 theUri, useImageManager.

Returns
  • The image URI for the player's portrait banner image, or null if the player has none.

publicCurrentPlayerInfogetCurrentPlayerInfo()

Returns information only available for the signed-in user. The method will returnnull for other players.

public voidgetDisplayName(CharArrayBuffer dataOut)

Loads the player's display name into the givenCharArrayBuffer.

Parameters
dataOutThe buffer to load the data into.

publicStringgetDisplayName()

Retrieves the display name for this player.

Returns
  • The player's display name.

publicUrigetHiResImageUri()

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 theUri, useImageManager.

Returns
  • The image URI for the player's hi-res profile image, or null if the player has none.

publicUrigetIconImageUri()

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 theUri, useImageManager.

Returns
  • The image URI for the player's icon-size profile image, or null if the player has none.

public longgetLastPlayedWithTimestamp()

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 returnsTIMESTAMP_UNKNOWN.

Returns
  • The timestamp (in ms since epoch) at which the player last played a multiplayer game with the currently signed in user.

publicPlayerLevelInfogetLevelInfo()

Retrieves the player level associated information if any exists. If no level information exists for this player, this method will returnnull.

Returns

publicStringgetPlayerId()

Retrieves the ID of this player.

Returns
  • The player ID.

publicPlayerRelationshipInfogetRelationshipInfo()

Returns relationship information of this player. If no relationship information exists for this player, this method will returnnull.

public longgetRetrievedTimestamp()

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.

publicStringgetTitle()

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

public voidgetTitle(CharArrayBuffer dataOut)

Loads the player's title into the givenCharArrayBuffer.

Parameters
dataOutThe buffer to load the data into.

public booleanhasHiResImage()

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

Indicates whether this player has an icon-size profile image to display.

Returns
  • Whether the player has an icon-size profile image to display.

public inthashCode()

public booleanisDataValid()

publicStringtoString()

public voidwriteToParcel(Parcel dest, int flags)

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-10-31 UTC.