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.
Inherited Constant Summary
Field Summary
public static final Creator<InvitationEntity> | CREATOR |
Public Method Summary
boolean | |
Invitation |
freeze()
|
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
Participant s
for this object.
|
int |
getVariant()
Retrieve the variant specified for this
Invitation ,
if any.
|
int |
hashCode()
|
boolean | |
void |
setShouldDowngrade(boolean arg0)
|
String |
toString()
|
void |
writeToParcel(Parcel dest, int
flags)
|
Protected Method Summary
static boolean |
canUnparcelSafely(String arg0)
|
static Integer | |
abstract boolean |
prepareForClientVersion(int arg0)
|
boolean |
Inherited Method Summary
Fields
public static final Creator<InvitationEntity> CREATOR
Public Methods
public boolean equals (Object obj)
public Invitation freeze ()
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
Game
object for thisInvitation
.
public String getInvitationId ()
Retrieve the ID of this Invitation
.
Returns
- The ID of this
Invitation
.
public Participant getInviter ()
Retrieve the Participant
who created this Invitation
.
Returns
- The
Participant
who created thisInvitation
.
public ArrayList<Participant> getParticipants ()
Retrieve the Participant
s
for this object. This is a list of all Participants applicable to the given object.
Returns
- A list of
Participant
s for this object.
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.