TurnBasedMatch (Google Play Game Services API v1 (Rev. 120) 1.18.0-rc)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.games.model.TurnBasedMatch

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class TurnBasedMatch
extends GenericJson
```
This is a JSON template for a turn-based match resource object.
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
  GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

TurnBasedMatch()

Constructors
Constructor and Description
`TurnBasedMatch()`

Method Summary

Methods
Modifier and Type	Method and Description
`TurnBasedMatch`	`clone()`
`String`	`getApplicationId()` The ID of the application being played.
`TurnBasedAutoMatchingCriteria`	`getAutoMatchingCriteria()` Criteria for auto-matching players into this match.
`TurnBasedMatchModification`	`getCreationDetails()` Details about the match creation.
`TurnBasedMatchData`	`getData()` The data / game state for this match.
`String`	`getDescription()` This short description is generated by our servers based on turn state and is localized and worded relative to the player requesting the match.
`String`	`getInviterId()` The ID of the participant that invited the user to the match.
`String`	`getKind()` Uniquely identifies the type of this resource.
`TurnBasedMatchModification`	`getLastUpdateDetails()` Details about the last update to the match.
`String`	`getMatchId()` Globally unique ID for a turn-based match.
`Integer`	`getMatchNumber()` The number of the match in a chain of rematches.
`Integer`	`getMatchVersion()` The version of this match: an increasing counter, used to avoid out-of-date updates to the match.
`List<TurnBasedMatchParticipant>`	`getParticipants()` The participants involved in the match, along with their statuses.
`String`	`getPendingParticipantId()` The ID of the participant that is taking a turn.
`TurnBasedMatchData`	`getPreviousMatchData()` The data / game state for the previous match; set for the first turn of rematches only.
`String`	`getRematchId()` The ID of a rematch of this match.
`List<ParticipantResult>`	`getResults()` The results reported for this match.
`String`	`getStatus()` The status of the match.
`String`	`getUserMatchStatus()` The status of the current user in the match.
`Integer`	`getVariant()` The variant / mode of the application being played; can be any integer value, or left blank.
`String`	`getWithParticipantId()` The ID of another participant in the match that can be used when describing the participants the user is playing with.
`TurnBasedMatch`	`set(String fieldName, Object value)`
`TurnBasedMatch`	`setApplicationId(String applicationId)` The ID of the application being played.
`TurnBasedMatch`	`setAutoMatchingCriteria(TurnBasedAutoMatchingCriteria autoMatchingCriteria)` Criteria for auto-matching players into this match.
`TurnBasedMatch`	`setCreationDetails(TurnBasedMatchModification creationDetails)` Details about the match creation.
`TurnBasedMatch`	`setData(TurnBasedMatchData data)` The data / game state for this match.
`TurnBasedMatch`	`setDescription(String description)` This short description is generated by our servers based on turn state and is localized and worded relative to the player requesting the match.
`TurnBasedMatch`	`setInviterId(String inviterId)` The ID of the participant that invited the user to the match.
`TurnBasedMatch`	`setKind(String kind)` Uniquely identifies the type of this resource.
`TurnBasedMatch`	`setLastUpdateDetails(TurnBasedMatchModification lastUpdateDetails)` Details about the last update to the match.
`TurnBasedMatch`	`setMatchId(String matchId)` Globally unique ID for a turn-based match.
`TurnBasedMatch`	`setMatchNumber(Integer matchNumber)` The number of the match in a chain of rematches.
`TurnBasedMatch`	`setMatchVersion(Integer matchVersion)` The version of this match: an increasing counter, used to avoid out-of-date updates to the match.
`TurnBasedMatch`	`setParticipants(List<TurnBasedMatchParticipant> participants)` The participants involved in the match, along with their statuses.
`TurnBasedMatch`	`setPendingParticipantId(String pendingParticipantId)` The ID of the participant that is taking a turn.
`TurnBasedMatch`	`setPreviousMatchData(TurnBasedMatchData previousMatchData)` The data / game state for the previous match; set for the first turn of rematches only.
`TurnBasedMatch`	`setRematchId(String rematchId)` The ID of a rematch of this match.
`TurnBasedMatch`	`setResults(List<ParticipantResult> results)` The results reported for this match.
`TurnBasedMatch`	`setStatus(String status)` The status of the match.
`TurnBasedMatch`	`setUserMatchStatus(String userMatchStatus)` The status of the current user in the match.
`TurnBasedMatch`	`setVariant(Integer variant)` The variant / mode of the application being played; can be any integer value, or left blank.
`TurnBasedMatch`	`setWithParticipantId(String withParticipantId)` The ID of another participant in the match that can be used when describing the participants the user is playing with.

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
  - TurnBasedMatch
```
public TurnBasedMatch()
```
- Method Detail
  - getApplicationId
```
public String getApplicationId()
```
    The ID of the application being played.
    
    Returns:
    value or null for none
  - setApplicationId
```
public TurnBasedMatch setApplicationId(String applicationId)
```
    The ID of the application being played.
    
    Parameters:
    applicationId - applicationId or null for none
  - getAutoMatchingCriteria
```
public TurnBasedAutoMatchingCriteria getAutoMatchingCriteria()
```
    Criteria for auto-matching players into this match.
    
    Returns:
    value or null for none
  - setAutoMatchingCriteria
```
public TurnBasedMatch setAutoMatchingCriteria(TurnBasedAutoMatchingCriteria autoMatchingCriteria)
```
    Criteria for auto-matching players into this match.
    
    Parameters:
    autoMatchingCriteria - autoMatchingCriteria or null for none
  - getCreationDetails
```
public TurnBasedMatchModification getCreationDetails()
```
    Details about the match creation.
    
    Returns:
    value or null for none
  - setCreationDetails
```
public TurnBasedMatch setCreationDetails(TurnBasedMatchModification creationDetails)
```
    Details about the match creation.
    
    Parameters:
    creationDetails - creationDetails or null for none
  - getData
```
public TurnBasedMatchData getData()
```
    The data / game state for this match.
    
    Returns:
    value or null for none
  - setData
```
public TurnBasedMatch setData(TurnBasedMatchData data)
```
    The data / game state for this match.
    
    Parameters:
    data - data or null for none
  - getDescription
```
public String getDescription()
```
    This short description is generated by our servers based on turn state and is localized and worded relative to the player requesting the match. It is intended to be displayed when the match is shown in a list.
    
    Returns:
    value or null for none
  - setDescription
```
public TurnBasedMatch setDescription(String description)
```
    This short description is generated by our servers based on turn state and is localized and worded relative to the player requesting the match. It is intended to be displayed when the match is shown in a list.
    
    Parameters:
    description - description or null for none
  - getInviterId
```
public String getInviterId()
```
    The ID of the participant that invited the user to the match. Not set if the user was not invited to the match.
    
    Returns:
    value or null for none
  - setInviterId
```
public TurnBasedMatch setInviterId(String inviterId)
```
    The ID of the participant that invited the user to the match. Not set if the user was not invited to the match.
    
    Parameters:
    inviterId - inviterId or null for none
  - getKind
```
public String getKind()
```
    Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatch.
    
    Returns:
    value or null for none
  - setKind
```
public TurnBasedMatch setKind(String kind)
```
    Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatch.
    
    Parameters:
    kind - kind or null for none
  - getLastUpdateDetails
```
public TurnBasedMatchModification getLastUpdateDetails()
```
    Details about the last update to the match.
    
    Returns:
    value or null for none
  - setLastUpdateDetails
```
public TurnBasedMatch setLastUpdateDetails(TurnBasedMatchModification lastUpdateDetails)
```
    Details about the last update to the match.
    
    Parameters:
    lastUpdateDetails - lastUpdateDetails or null for none
  - getMatchId
```
public String getMatchId()
```
    Globally unique ID for a turn-based match.
    
    Returns:
    value or null for none
  - setMatchId
```
public TurnBasedMatch setMatchId(String matchId)
```
    Globally unique ID for a turn-based match.
    
    Parameters:
    matchId - matchId or null for none
  - getMatchNumber
```
public Integer getMatchNumber()
```
    The number of the match in a chain of rematches. Will be set to 1 for the first match and incremented by 1 for each rematch.
    
    Returns:
    value or null for none
  - setMatchNumber
```
public TurnBasedMatch setMatchNumber(Integer matchNumber)
```
    The number of the match in a chain of rematches. Will be set to 1 for the first match and incremented by 1 for each rematch.
    
    Parameters:
    matchNumber - matchNumber or null for none
  - getMatchVersion
```
public Integer getMatchVersion()
```
    The version of this match: an increasing counter, used to avoid out-of-date updates to the match.
    
    Returns:
    value or null for none
  - setMatchVersion
```
public TurnBasedMatch setMatchVersion(Integer matchVersion)
```
    The version of this match: an increasing counter, used to avoid out-of-date updates to the match.
    
    Parameters:
    matchVersion - matchVersion or null for none
  - getParticipants
```
public List<TurnBasedMatchParticipant> getParticipants()
```
    The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations.
    
    Returns:
    value or null for none
  - setParticipants
```
public TurnBasedMatch setParticipants(List<TurnBasedMatchParticipant> participants)
```
    The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations.
    
    Parameters:
    participants - participants or null for none
  - getPendingParticipantId
```
public String getPendingParticipantId()
```
    The ID of the participant that is taking a turn.
    
    Returns:
    value or null for none
  - setPendingParticipantId
```
public TurnBasedMatch setPendingParticipantId(String pendingParticipantId)
```
    The ID of the participant that is taking a turn.
    
    Parameters:
    pendingParticipantId - pendingParticipantId or null for none
  - getPreviousMatchData
```
public TurnBasedMatchData getPreviousMatchData()
```
    The data / game state for the previous match; set for the first turn of rematches only.
    
    Returns:
    value or null for none
  - setPreviousMatchData
```
public TurnBasedMatch setPreviousMatchData(TurnBasedMatchData previousMatchData)
```
    The data / game state for the previous match; set for the first turn of rematches only.
    
    Parameters:
    previousMatchData - previousMatchData or null for none
  - getRematchId
```
public String getRematchId()
```
    The ID of a rematch of this match. Only set for completed matches that have been rematched.
    
    Returns:
    value or null for none
  - setRematchId
```
public TurnBasedMatch setRematchId(String rematchId)
```
    The ID of a rematch of this match. Only set for completed matches that have been rematched.
    
    Parameters:
    rematchId - rematchId or null for none
  - getResults
```
public List<ParticipantResult> getResults()
```
    The results reported for this match.
    
    Returns:
    value or null for none
  - setResults
```
public TurnBasedMatch setResults(List<ParticipantResult> results)
```
    The results reported for this match.
    
    Parameters:
    results - results or null for none
  - getStatus
```
public String getStatus()
```
    The status of the match. Possible values are: - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; the match cannot be established until they are filled. - "MATCH_ACTIVE" - The match has started. - "MATCH_COMPLETE" - The match has finished. - "MATCH_CANCELED" - The match was canceled. - "MATCH_EXPIRED" - The match expired due to inactivity. - "MATCH_DELETED" - The match should no longer be shown on the client. Returned only for tombstones for matches when sync is called.
    
    Returns:
    value or null for none
  - setStatus
```
public TurnBasedMatch setStatus(String status)
```
    The status of the match. Possible values are: - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; the match cannot be established until they are filled. - "MATCH_ACTIVE" - The match has started. - "MATCH_COMPLETE" - The match has finished. - "MATCH_CANCELED" - The match was canceled. - "MATCH_EXPIRED" - The match expired due to inactivity. - "MATCH_DELETED" - The match should no longer be shown on the client. Returned only for tombstones for matches when sync is called.
    
    Parameters:
    status - status or null for none
  - getUserMatchStatus
```
public String getUserMatchStatus()
```
    The status of the current user in the match. Derived from the match type, match status, the user's participant status, and the pending participant for the match. Possible values are: - "USER_INVITED" - The user has been invited to join the match and has not responded yet. - "USER_AWAITING_TURN" - The user is waiting for their turn. - "USER_TURN" - The user has an action to take in the match. - "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or expired.)
    
    Returns:
    value or null for none
  - setUserMatchStatus
```
public TurnBasedMatch setUserMatchStatus(String userMatchStatus)
```
    The status of the current user in the match. Derived from the match type, match status, the user's participant status, and the pending participant for the match. Possible values are: - "USER_INVITED" - The user has been invited to join the match and has not responded yet. - "USER_AWAITING_TURN" - The user is waiting for their turn. - "USER_TURN" - The user has an action to take in the match. - "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or expired.)
    
    Parameters:
    userMatchStatus - userMatchStatus or null for none
  - getVariant
```
public Integer getVariant()
```
    The variant / mode of the application being played; can be any integer value, or left blank.
    
    Returns:
    value or null for none
  - setVariant
```
public TurnBasedMatch setVariant(Integer variant)
```
    The variant / mode of the application being played; can be any integer value, or left blank.
    
    Parameters:
    variant - variant or null for none
  - getWithParticipantId
```
public String getWithParticipantId()
```
    The ID of another participant in the match that can be used when describing the participants the user is playing with.
    
    Returns:
    value or null for none
  - setWithParticipantId
```
public TurnBasedMatch setWithParticipantId(String withParticipantId)
```
    The ID of another participant in the match that can be used when describing the participants the user is playing with.
    
    Parameters:
    withParticipantId - withParticipantId or null for none
  - set
```
public TurnBasedMatch set(String fieldName,
                 Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public TurnBasedMatch clone()
```
    Overrides:
    
    clone in class GenericJson

Google Play Game Services API v1 (revision 120)

Class TurnBasedMatch

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Constructor Detail

TurnBasedMatch

Method Detail

getApplicationId

setApplicationId

getAutoMatchingCriteria

setAutoMatchingCriteria

getCreationDetails

setCreationDetails

getData

setData

getDescription

setDescription

getInviterId

setInviterId

getKind

setKind

getLastUpdateDetails

setLastUpdateDetails

getMatchId

setMatchId

getMatchNumber

setMatchNumber

getMatchVersion

setMatchVersion

getParticipants

setParticipants

getPendingParticipantId

setPendingParticipantId

getPreviousMatchData

setPreviousMatchData

getRematchId

setRematchId

getResults

setResults

getStatus

setStatus

getUserMatchStatus

setUserMatchStatus

getVariant

setVariant

getWithParticipantId

setWithParticipantId

set

clone