Hide

Participant

public interface Participant implements Freezable<Participant> Parcelable
com.google.android.gms.games.multiplayer.Participant
Known Indirect Subclasses

Data interface for multiplayer participants.

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.

Inherited Constant Summary

Public Method Summary

abstract String
abstract void
abstract Uri
abstract Uri
abstract String
abstract Player
abstract ParticipantResult
abstract int
abstract boolean

Constants

public static final int STATUS_DECLINED

Constant indicating that this participant has declined the invitation.

Constant Value: 3

public static final int STATUS_FINISHED

Constant indicating that this participant is finished with this match. Only applies to turn-based match participants.

Constant Value: 5

public static final int STATUS_INVITED

Constant indicating that this participant has been sent an invitation.

Constant Value: 1

public static final int STATUS_JOINED

Constant indicating that this participant has accepted the invitation and is joined.

Constant Value: 2

public static final int STATUS_LEFT

Constant indicating that this participant joined a multiplayer game and subsequently left.

Constant Value: 4

public static final int STATUS_NOT_INVITED_YET

Constant indicating that this participant has not yet been sent an invitation. Only applies to turn-based match participants.

Constant Value: 0

public static final int STATUS_UNRESPONSIVE

Constant indicating that this participant did not respond to the match in the alloted time. Only applies to turn-based match participants.

Constant Value: 6

Public Methods

public abstract 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
  • Display name of the participant.

public abstract void getDisplayName (CharArrayBuffer dataOut)

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

Parameters
dataOut The buffer to load the data into.

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

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

public abstract 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
  • The ID of this participant.

public abstract 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
  • The Player corresponding to this participant.

public abstract ParticipantResult getResult ()

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

Returns

public abstract 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
  • Status of this participant.

public abstract 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
  • Connected status of the participant.