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.
Inherited Constant Summary
|int||RECIPIENT_STATUS_ACCEPTED||Constant indicating that the request has been accepted.|
|int||RECIPIENT_STATUS_PENDING||Constant indicating that the request is still pending.|
|int||STATUS_ACCEPTED||Constant indicating that this request has been accepted.|
|int||STATUS_PENDING||Constant indicating that this request has not been acted on yet.|
|int||TYPE_ALL||Array of all the request type constants.|
|int||TYPE_GIFT||Request type indicating that the sender is giving something to the recipient.|
|int||TYPE_WISH||Request type indicating that the sender is asking for something from the recipient.|
|public static final Creator<GameRequestEntity>||CREATOR|
Public Method Summary
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.
- A concrete implementation of the data object.
public long getCreationTimestamp ()
public byte getData ()
Retrieves the data associated with the request.
- The data associated with the request.
public long getExpirationTimestamp ()
public Game getGame ()
Retrieves the game associated with this request.
- The associated game.
public int getRecipientStatus (String playerId)
Retrieves the information about all the players that the request was sent to.
- The players that are receiving the request.
public String getRequestId ()
Retrieves the ID of this request.
- The request ID.
public Player getSender ()
Retrieves the information about the player that sent the request.
- The player that sent the request.
public int getStatus ()
public int getType ()
public int hashCode ()
public boolean isConsumed (String playerId)
Retrieves whether the request was consumed by a specific recipient.
|playerId||The player ID for which the consumed state should be queried.|
- 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.
- whether or not the object is valid for use.