public final class

RoomEntity

extends Object
implements SafeParcelable Room
java.lang.Object
   ↳ com.google.android.gms.games.multiplayer.realtime.RoomEntity

Class Overview

Data object representing the data for a room. This is immutable, andtherefore 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.common.internal.safeparcel.SafeParcelable
From interface com.google.android.gms.games.multiplayer.realtime.Room
Fields
public static final Creator<RoomEntity> CREATOR
Public Methods
int describeContents()
boolean equals(Object obj)
Room freeze()
Freeze a volatile representation into an immutable representation.
Bundle getAutoMatchCriteria()
Retrieves the automatch criteria used to create or join this room, if any.
int getAutoMatchWaitEstimateSeconds()
Retrieves the estimated wait time for automatching to finish for players who are not automatched immediately, as measured from the time that the room entered the automatching pool.
long getCreationTimestamp()
String getCreatorId()
String getDescription()
void getDescription(CharArrayBuffer dataOut)
Loads the room description into the given CharArrayBuffer.
Participant getParticipant(String participantId)
Get a participant in a room by its ID.
String getParticipantId(String playerId)
Get the participant ID for a given player.
ArrayList<String> getParticipantIds()
Get the IDs of the participants of the given room.
int getParticipantStatus(String participantId)
Get the status of a participant in a room.
ArrayList<Participant> getParticipants()
Retrieve the Participants for this object.
String getRoomId()
int getStatus()
int getVariant()
int hashCode()
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.common.data.Freezable
From interface com.google.android.gms.games.multiplayer.Participatable
From interface com.google.android.gms.games.multiplayer.realtime.Room

Fields

public static final Creator<RoomEntity> CREATOR

Public Methods

public int describeContents ()

public boolean equals (Object obj)

public Room 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
  • A concrete implementation of the data object.

public Bundle getAutoMatchCriteria ()

Retrieves the automatch criteria used to create or join this room, if any. May be null if the room has no automatch properties.

Returns
  • A bundle containing the automatch criteria for this room.

public int getAutoMatchWaitEstimateSeconds ()

Retrieves the estimated wait time for automatching to finish for players who are not automatched immediately, as measured from the time that the room entered the automatching pool.

Returns
  • The estimated wait time in seconds, or -1 if the room is not automatching or no estimate could be provided.

public long getCreationTimestamp ()

public String getCreatorId ()

public String getDescription ()

public void getDescription (CharArrayBuffer dataOut)

Loads the room description into the given CharArrayBuffer.

Parameters
dataOut The buffer to load the data into.

public Participant getParticipant (String participantId)

Get a participant in a room by its ID. Note that the participant ID must correspond to a participant in this match, or this method will throw an exception.

Parameters
participantId Match-local ID of the participant to retrieve status for.
Returns
  • The participant corresponding to the given ID.

public String getParticipantId (String playerId)

Get the participant ID for a given player. This will only return a non-null ID if the player is actually a participant in the room and that player's identity is visible to the current player. Note that this will always return non-null for the current player.

Parameters
playerId Player ID to find participant ID for.
Returns
  • The participant ID corresponding to given player, or null if none found.

public ArrayList<String> getParticipantIds ()

Get the IDs of the participants of the given room.

Returns
  • The IDs of the participants in this room. These are returned in the participant order of the room. Note that these are not stable across rooms.

public int getParticipantStatus (String participantId)

Get the status of a participant in a room. Note that the participant ID must correspond to a participant in this room, or this method will throw an exception.

Parameters
participantId Room-local ID of the participant to retrieve status for.
Returns

public ArrayList<Participant> getParticipants ()

Retrieve the Participants for this object. This is a list of all Participants applicable to the given object.

Returns

public String getRoomId ()

public int getStatus ()

public int getVariant ()

public int hashCode ()

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
  • whether or not the object is valid for use.

public String toString ()

public void writeToParcel (Parcel dest, int flags)