public final class

GameRequestEntity

extends Object
implements Parcelable GameRequest
java.lang.Object
   ↳ com.google.android.gms.games.request.GameRequestEntity

Class Overview

Data object representing the data for a request. 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.games.request.GameRequest
Fields
public static final GameRequestEntityCreator CREATOR
Public Methods
int describeContents()
boolean equals(Object obj)
GameRequest freeze()
Freeze a volatile representation into an immutable representation.
long getCreationTimestamp()
byte[] getData()
Retrieves the data associated with the request.
long getExpirationTimestamp()
Game getGame()
Retrieves the game associated with this request.
int getRecipientStatus(String playerId)
Retrieves the status of the request for a given recipient.
List<Player> getRecipients()
Retrieves the information about all the players that the request was sent to.
String getRequestId()
Retrieves the ID of this request.
Player getSender()
Retrieves the information about the player that sent the request.
int getStatus()
Retrieves the status of the request as an overall status depending on all recipients.
int getType()
Retrieves the type of this request.
int hashCode()
boolean isConsumed(String playerId)
Retrieves whether the request was consumed by a specific recipient.
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.request.GameRequest

Fields

public static final GameRequestEntityCreator CREATOR

Public Methods

public int describeContents ()

public boolean equals (Object obj)

public GameRequest 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 long getCreationTimestamp ()

public byte[] getData ()

Retrieves the data associated with the request.

Returns
  • The data associated with the request.

public long getExpirationTimestamp ()

public Game getGame ()

Retrieves the game associated with this request.

Returns
  • The associated game.

public int getRecipientStatus (String playerId)

Retrieves the status of the request for a given recipient.

Parameters
playerId The player ID for which the consumed state should be queried.
Returns

public List<Player> getRecipients ()

Retrieves the information about all the players that the request was sent to.

Returns
  • The players that are receiving the request.

public String getRequestId ()

Retrieves the ID of this request.

Returns
  • The request ID.

public Player getSender ()

Retrieves the information about the player that sent the request.

Returns
  • The player that sent the request.

public int getStatus ()

Retrieves the status of the request as an overall status depending on all recipients.

Returns

public int getType ()

Retrieves the type of this request.

Returns

public int hashCode ()

public boolean isConsumed (String playerId)

Retrieves whether the request was consumed by a specific recipient.

Parameters
playerId The player ID for which the consumed state should be queried.
Returns
  • True if the request was consumed by the given recipient.

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)