public final class

InvitationEntity

extends Object
implements SafeParcelable Invitation
java.lang.Object
   ↳ com.google.android.gms.games.multiplayer.InvitationEntity

Class Overview

Data object representing the data for a multiplayer invitation. 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.common.internal.safeparcel.SafeParcelable
From interface com.google.android.gms.games.multiplayer.Invitation
Fields
public static final Creator<InvitationEntity> CREATOR
Public Methods
int describeContents()
boolean equals(Object obj)
Invitation freeze()
Freeze a volatile representation into an immutable representation.
int getAvailableAutoMatchSlots()
Return the maximum number of available automatch slots for this invitation.
long getCreationTimestamp()
Retrieve the server timestamp at which this Invitation was created.
Game getGame()
Retrieve the Game object that this Invitation is associated with.
String getInvitationId()
Retrieve the ID of this Invitation.
Participant getInviter()
Retrieve the Participant who created this Invitation.
ArrayList<Participant> getParticipants()
Retrieve the Participants for this object.
int getVariant()
Retrieve the variant specified for this Invitation, if any.
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.Invitation
From interface com.google.android.gms.games.multiplayer.Participatable

Fields

public static final Creator<InvitationEntity> CREATOR

Public Methods

public int describeContents ()

public boolean equals (Object obj)

public Invitation 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 int getAvailableAutoMatchSlots ()

Return the maximum number of available automatch slots for this invitation. If automatch criteria were not specified during creation, or if all slots have been filled, this will return 0.

Returns
  • The maximum number of additional players that can be added to this game.

public long getCreationTimestamp ()

Retrieve the server timestamp at which this Invitation was created.

Returns
  • The server timestamp at which this Invitation was created.

public Game getGame ()

Retrieve the Game object that this Invitation is associated with.

Returns

public String getInvitationId ()

Retrieve the ID of this Invitation.

Returns

public Participant getInviter ()

Retrieve the Participant who created this Invitation.

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 int getVariant ()

Retrieve the variant specified for this Invitation, if any. A variant is an optional developer-controlled parameter describing the type of game to play. If specified, this value will be a positive integer. If this invitation had no variant specified, returns ROOM_VARIANT_DEFAULT or MATCH_VARIANT_DEFAULT.

Returns
  • Variant specified for this invitation, if any.

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)