Player

  • ThePlayer interface provides data for retrieving player information and implementsFreezable andParcelable.

  • It includes nested interfaces forFriendsListVisibilityStatus andPlayerFriendStatus.

  • Constants are provided forCURRENT_XP_UNKNOWN andTIMESTAMP_UNKNOWN.

  • Various methods allow retrieval of player details such as display name, player ID, level info, relationship info, titles, and profile/banner image URIs.

  • Methods inherited fromFreezable includefreeze() andisDataValid(), whileParcelable methods aredescribeContents() andwriteToParcel().

public interfacePlayer implementsFreezable<Player>Parcelable
Known Indirect Subclasses
PlayerEntityData object representing a set of Player data. 

Data interface for retrieving player information.

Nested Class Summary

@interface Player.FriendsListVisibilityStatusFriends list visibility statuses. 
@interfacePlayer.PlayerFriendStatusPlayer friend statuses. 

Constant Summary

longCURRENT_XP_UNKNOWNConstant indicating that the current XP total for a player is not known.
longTIMESTAMP_UNKNOWNConstant indicating that a timestamp for a player is not known.

Inherited Constant Summary

From interface android.os.Parcelable
intCONTENTS_FILE_DESCRIPTOR
intPARCELABLE_WRITE_RETURN_VALUE

Public Method Summary

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 givenCharArrayBuffer.
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.
abstractPlayerRelationshipInfo
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 givenCharArrayBuffer.
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.

Inherited Method Summary

From interface com.google.android.gms.common.data.Freezable
abstractPlayer
freeze()
abstract boolean
isDataValid()
From interface android.os.Parcelable
abstract int
describeContents()
abstract void
writeToParcel(Parcel arg0, int arg1)

Constants

public static final longCURRENT_XP_UNKNOWN

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

Constant Value:-1

public static final longTIMESTAMP_UNKNOWN

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

Constant Value:-1

Public Methods

public abstractUrigetBannerImageLandscapeUri()

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.

public abstractUrigetBannerImagePortraitUri()

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.

public abstractCurrentPlayerInfogetCurrentPlayerInfo()

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

public abstract voidgetDisplayName(CharArrayBuffer dataOut)

Loads the player's display name into the givenCharArrayBuffer.

Parameters
dataOutThe buffer to load the data into.

public abstractStringgetDisplayName()

Retrieves the display name for this player.

Returns
  • The player's display name.

public abstractUrigetHiResImageUri()

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.

public abstractUrigetIconImageUri()

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

This method is deprecated.
Real-time multiplayer and Turn-based multiplayer support is being shut down on March 31, 2020. SeeMultiplayer 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 returnsTIMESTAMP_UNKNOWN.

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

public abstractPlayerLevelInfogetLevelInfo()

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

Returns

public abstractStringgetPlayerId()

Retrieves the ID of this player.

Returns
  • The player ID.

public abstractPlayerRelationshipInfogetRelationshipInfo()

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

public abstract 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.

public abstractStringgetTitle()

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 abstract voidgetTitle(CharArrayBuffer dataOut)

Loads the player's title into the givenCharArrayBuffer.

Parameters
dataOutThe buffer to load the data into.

public abstract 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 abstract 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.

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.