Hide

GameRequest

public interface GameRequest implements Freezable<GameRequest> Parcelable
com.google.android.gms.games.request.GameRequest
Known Indirect Subclasses

Data interface for game requests.

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.

Inherited Constant Summary

Public Method Summary

abstract long
abstract byte[]
abstract long
abstract Game
abstract int
abstract List<Player>
abstract String
abstract Player
abstract int
abstract int
abstract boolean
isConsumed(String playerId)

Constants

public static final int RECIPIENT_STATUS_ACCEPTED

Constant indicating that the request has been accepted.

Constant Value: 1

public static final int RECIPIENT_STATUS_PENDING

Constant indicating that the request is still pending.

Constant Value: 0

public static final int STATUS_ACCEPTED

Constant indicating that this request has been accepted. Note - not being returned from server at the moment.

Constant Value: 1

public static final int STATUS_PENDING

Constant indicating that this request has not been acted on yet.

Constant Value: 0

public static final int TYPE_ALL

Array of all the request type constants.

Constant Value: 65535

public static final int TYPE_GIFT

Request type indicating that the sender is giving something to the recipient.

Constant Value: 1

public static final int TYPE_WISH

Request type indicating that the sender is asking for something from the recipient.

Constant Value: 2

Public Methods

public abstract long getCreationTimestamp ()

Returns
  • The server timestamp (in milliseconds from epoch) at which this request was created.

public abstract byte[] getData ()

Retrieves the data associated with the request.

Returns
  • The data associated with the request.

public abstract long getExpirationTimestamp ()

Returns
  • The server timestamp (in milliseconds from epoch) at which this request will expire.

public abstract Game getGame ()

Retrieves the game associated with this request.

Returns
  • The associated game.

public abstract 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 abstract 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 abstract String getRequestId ()

Retrieves the ID of this request.

Returns
  • The request ID.

public abstract Player getSender ()

Retrieves the information about the player that sent the request.

Returns
  • The player that sent the request.

public abstract int getStatus ()

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

Returns

public abstract int getType ()

Retrieves the type of this request.

Returns

public abstract 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.