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.
Inherited Constant Summary
|int||STATUS_DECLINED||Constant indicating that this participant has declined the invitation.|
|int||STATUS_FINISHED||Constant indicating that this participant is finished with this match.|
|int||STATUS_INVITED||Constant indicating that this participant has been sent an invitation.|
|int||STATUS_JOINED||Constant indicating that this participant has accepted the invitation and is joined.|
|int||STATUS_LEFT||Constant indicating that this participant joined a multiplayer game and subsequently left.|
|int||STATUS_NOT_INVITED_YET||Constant indicating that this participant has not yet been sent an invitation.|
|int||STATUS_UNRESPONSIVE||Constant indicating that this participant did not respond to the match in the alloted time.|
|public static final Creator<ParticipantEntity>||CREATOR|
Public Method Summary
public int describeContents ()
public boolean equals (Object obj)
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.
- A concrete implementation of the data object.
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.
- Display name of the participant.
public void getDisplayName (CharArrayBuffer dataOut)
Loads the display name for this participant into the provided
|dataOut||The buffer to load the data into.|
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.
- 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.
- 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.
- The ID of this participant.
public Player getPlayer ()
public ParticipantResult getResult ()
public int getStatus ()
Retrieve the status of this participant.
- Status of this participant.
public int hashCode ()
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.
- 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.
- whether or not the object is valid for use.