java.lang.Object | |
↳ | com.google.android.gms.games.multiplayer.ParticipantEntity |
Data object representing a Participant in a match. 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.
[Expand]
Inherited Constants | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
From interface
android.os.Parcelable
| |||||||||||||||||||||||
From interface
com.google.android.gms.games.multiplayer.Participant
|
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
CREATOR |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Freeze a volatile representation into an immutable representation.
| |||||||||||
Return the name to display for this participant.
| |||||||||||
Loads the display name for this participant into the provided
CharArrayBuffer . | |||||||||||
Returns the URI of the hi-res image to display for this participant.
| |||||||||||
Returns the URI of the icon-sized image to display for this participant.
| |||||||||||
Returns the ID of this participant.
| |||||||||||
Returns the
Player that this participant represents. | |||||||||||
Retrieve the status of this participant.
| |||||||||||
Retrieves the connected status of the participant.
| |||||||||||
Check to see if this object is valid for use.
| |||||||||||
[Expand]
Inherited Methods | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||||||||||||||||||||||||
From interface
android.os.Parcelable
| |||||||||||||||||||||||||||||||||
From interface
com.google.android.gms.common.data.Freezable
| |||||||||||||||||||||||||||||||||
From interface
com.google.android.gms.games.multiplayer.Participant
|
Freeze a volatile representation into an immutable representation. Objects returned from this call are safe to cache.
Note that the output of freeze
may not be identical to the parent object, but should
be equal. In other words:
Freezable f1 = new Freezable();
Freezable f2 = f1.freeze();
f1 == f2 may not be true.
f1.equals(f2) will be true.
Return the name to display for this participant. If the identity of the player is unknown, this will be a generic handle to describe the player.
Loads the display name for this participant into the provided CharArrayBuffer
.
dataOut | The buffer to load the data into. |
---|
Returns the URI of the hi-res image to display for this participant. If the identity of the player is unknown, this will be null. It may also be null if the player simply has no image.
To retrieve the Image from the Uri
, use ImageManager
.
Returns the URI of the icon-sized image to display for this participant. If the identity of the player is unknown, this will be the automatch avatar icon image for the player. It may also be null if the player simply has no image.
To retrieve the Image from the Uri
, use ImageManager
.
Returns the ID of this participant. Note that this is only valid for use in the current multiplayer room: a participant will not have the same ID across multiple rooms.
Retrieve the status of this participant. Possible values are STATUS_INVITED
,
STATUS_JOINED
, STATUS_DECLINED
, or STATUS_LEFT
.
Retrieves the connected status of the participant. If true indicates that participant is in the connected set of the room.
Check to see if this object is valid for use. If the object is still volatile, this method
will indicate whether or not the object can be safely used. The output of a call to
freeze()
will always be valid.