com.google.api.services.games.model

Class TurnBasedMatchParticipant

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.games.model.TurnBasedMatchParticipant

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class TurnBasedMatchParticipant
extends com.google.api.client.json.GenericJson

This is a JSON template for a participant in a turn-based match.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Play Game Services API. For a detailed explanation see: http://code.google.com/p/google-http-java-client/wiki/JSON

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
TurnBasedMatchParticipant()

Method Summary

Methods

Modifier and Type	Method and Description
TurnBasedMatchParticipant	clone()
java.lang.Boolean	getAutoMatched() True if this participant was auto-matched with the requesting player.
AnonymousPlayer	getAutoMatchedPlayer() Information about a player that has been anonymously auto-matched against the requesting player.
java.lang.String	getId() An identifier for the participant in the scope of the match.
java.lang.String	getKind() Uniquely identifies the type of this resource.
Player	getPlayer() Information about the player.
java.lang.String	getStatus() The status of the participant with respect to the match.
TurnBasedMatchParticipant	set(java.lang.String fieldName, java.lang.Object value)
TurnBasedMatchParticipant	setAutoMatched(java.lang.Boolean autoMatched) True if this participant was auto-matched with the requesting player.
TurnBasedMatchParticipant	setAutoMatchedPlayer(AnonymousPlayer autoMatchedPlayer) Information about a player that has been anonymously auto-matched against the requesting player.
TurnBasedMatchParticipant	setId(java.lang.String id) An identifier for the participant in the scope of the match.
TurnBasedMatchParticipant	setKind(java.lang.String kind) Uniquely identifies the type of this resource.
TurnBasedMatchParticipant	setPlayer(Player player) Information about the player.
TurnBasedMatchParticipant	setStatus(java.lang.String status) The status of the participant with respect to the match.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TurnBasedMatchParticipant

public TurnBasedMatchParticipant()

Method Detail

getAutoMatched

public java.lang.Boolean getAutoMatched()

True if this participant was auto-matched with the requesting player.

Returns:

value or null for none

setAutoMatched

public TurnBasedMatchParticipant setAutoMatched(java.lang.Boolean autoMatched)

True if this participant was auto-matched with the requesting player.

Parameters:

autoMatched - autoMatched or null for none

getAutoMatchedPlayer

public AnonymousPlayer getAutoMatchedPlayer()

Information about a player that has been anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)

Returns:

value or null for none

setAutoMatchedPlayer

public TurnBasedMatchParticipant setAutoMatchedPlayer(AnonymousPlayer autoMatchedPlayer)

Information about a player that has been anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)

Parameters:

autoMatchedPlayer - autoMatchedPlayer or null for none

getId

public java.lang.String getId()

An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts.

Returns:

value or null for none

setId

public TurnBasedMatchParticipant setId(java.lang.String id)

An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts.

Parameters:

id - id or null for none

getKind

public java.lang.String getKind()

Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchParticipant.

Returns:

value or null for none

setKind

public TurnBasedMatchParticipant setKind(java.lang.String kind)

Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchParticipant.

Parameters:

kind - kind or null for none

getPlayer

public Player getPlayer()

Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)

Returns:

value or null for none

setPlayer

public TurnBasedMatchParticipant setPlayer(Player player)

Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)

Parameters:

player - player or null for none

getStatus

public java.lang.String getStatus()

The status of the participant with respect to the match. Possible values are: - "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be invited to the match, but the invitation has not been sent; the invite will be sent when it becomes their turn. - "PARTICIPANT_INVITED" - The participant has been invited to join the match, but has not yet responded. - "PARTICIPANT_JOINED" - The participant has joined the match (either after creating it or accepting an invitation.) - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the match. - "PARTICIPANT_LEFT" - The participant joined the match and then left it. - "PARTICIPANT_FINISHED" - The participant finished playing in the match. - "PARTICIPANT_UNRESPONSIVE" - The participant did not take their turn in the allotted time.

Returns:

value or null for none

setStatus

public TurnBasedMatchParticipant setStatus(java.lang.String status)

The status of the participant with respect to the match. Possible values are: - "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be invited to the match, but the invitation has not been sent; the invite will be sent when it becomes their turn. - "PARTICIPANT_INVITED" - The participant has been invited to join the match, but has not yet responded. - "PARTICIPANT_JOINED" - The participant has joined the match (either after creating it or accepting an invitation.) - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the match. - "PARTICIPANT_LEFT" - The participant joined the match and then left it. - "PARTICIPANT_FINISHED" - The participant finished playing in the match. - "PARTICIPANT_UNRESPONSIVE" - The participant did not take their turn in the allotted time.

Parameters:

status - status or null for none

set

public TurnBasedMatchParticipant set(java.lang.String fieldName,
                            java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public TurnBasedMatchParticipant clone()

Overrides:

clone in class com.google.api.client.json.GenericJson