public final class

ParticipantEntity

extends Object
implements Parcelable Parcelable Participant
java.lang.Object
   ↳ com.google.android.gms.games.multiplayer.ParticipantEntity

Class Overview

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.

Summary

[Expand]
Inherited Constants
From interface android.os.Parcelable
From interface com.google.android.gms.games.multiplayer.Participant
Fields
public static final Creator<ParticipantEntity> CREATOR
Public Methods
boolean equals(Object obj)
Participant freeze()
Freeze a volatile representation into an immutable representation.
void getDisplayName(CharArrayBuffer dataOut)
Loads the display name for this participant into the provided CharArrayBuffer.
String getDisplayName()
Return the name to display for this participant.
Uri getHiResImageUri()
Returns the URI of the hi-res image to display for this participant.
Uri getIconImageUri()
Returns the URI of the icon-sized image to display for this participant.
String getParticipantId()
Returns the ID of this participant.
Player getPlayer()
Returns the Player that this participant represents.
ParticipantResult getResult()
Returns the ParticipantResult associated with this participant, if any.
int getStatus()
Retrieve the status of this participant.
int hashCode()
boolean isConnectedToRoom()
Retrieves the connected status of the participant.
boolean isDataValid()
Check to see if this object is valid for use.
String toString()
void writeToParcel(Parcel dest, int flags)
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable
From interface com.google.android.gms.games.multiplayer.Participant
From interface com.google.android.gms.common.data.Freezable

Fields

public static final Creator<ParticipantEntity> CREATOR

Public Methods

public boolean equals (Object obj)

Parameters
obj Object
Returns
boolean

public Participant freeze ()

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.
 
 

Returns
Participant A concrete implementation of the data object.

public void getDisplayName (CharArrayBuffer dataOut)

Loads the display name for this participant into the provided CharArrayBuffer.

Parameters
dataOut CharArrayBuffer: The buffer to load the data into.

public String getDisplayName ()

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.

Returns
String Display name of the participant.

public Uri getHiResImageUri ()

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
Uri The URI of the hi-res image to display for this participant.

public Uri getIconImageUri ()

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
Uri The URI of the icon image to display for this participant.

public String getParticipantId ()

Returns the ID of this participant. Note that this is only valid for use in the current multiplayer room or match: a participant will not have the same ID across multiple rooms or matches.

Returns
String The ID of this participant.

public Player getPlayer ()

Returns the Player that this participant represents. Note that this may be null if the identity of the player is unknown. This occurs in automatching scenarios where some players are not permitted to see the real identity of others.

Returns
Player The Player corresponding to this participant.

public ParticipantResult getResult ()

Returns the ParticipantResult associated with this participant, if any. Only applies to turn-based match participants.

Returns
ParticipantResult The ParticipantResult for this participant, or null if not applicable.

public int getStatus ()

Retrieve the status of this participant.

Possible status values for room participants are STATUS_INVITED, STATUS_JOINED, STATUS_DECLINED, and STATUS_LEFT.

Possible status values for turn-based match participants are all of the above, STATUS_NOT_INVITED_YET, STATUS_FINISHED, and STATUS_UNRESPONSIVE.

Returns
int Status of this participant.

public int hashCode ()

Returns
int

public boolean isConnectedToRoom ()

Retrieves the connected status of the participant. If true indicates that participant is in the connected set of the room. Only applies to room participants.

Returns
boolean Connected status of the participant.

public boolean isDataValid ()

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.

Returns
boolean whether or not the object is valid for use.

public String toString ()

Returns
String

public void writeToParcel (Parcel dest, int flags)

Parameters
dest Parcel
flags int