com.google.api.services.games.model

Class TurnBasedMatch

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.TurnBasedMatch

All Implemented Interfaces:

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

public final class TurnBasedMatch
extends com.google.api.client.json.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: https://developers.google.com/api-client-library/java/google-http-java-client/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
TurnBasedMatch()

Method Summary

Modifier and Type	Method and Description
TurnBasedMatch	clone()
java.lang.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.
java.lang.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.
java.lang.String	getInviterId() The ID of the participant that invited the user to the match.
java.lang.String	getKind() Uniquely identifies the type of this resource.
TurnBasedMatchModification	getLastUpdateDetails() Details about the last update to the match.
java.lang.String	getMatchId() Globally unique ID for a turn-based match.
java.lang.Integer	getMatchNumber() The number of the match in a chain of rematches.
java.lang.Integer	getMatchVersion() The version of this match: an increasing counter, used to avoid out-of-date updates to the match.
java.util.List<TurnBasedMatchParticipant>	getParticipants() The participants involved in the match, along with their statuses.
java.lang.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.
java.lang.String	getRematchId() The ID of a rematch of this match.
java.util.List<ParticipantResult>	getResults() The results reported for this match.
java.lang.String	getStatus() The status of the match.
java.lang.String	getUserMatchStatus() The status of the current user in the match.
java.lang.Integer	getVariant() The variant / mode of the application being played; can be any integer value, or left blank.
java.lang.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(java.lang.String fieldName, java.lang.Object value)
TurnBasedMatch	setApplicationId(java.lang.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(java.lang.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(java.lang.String inviterId) The ID of the participant that invited the user to the match.
TurnBasedMatch	setKind(java.lang.String kind) Uniquely identifies the type of this resource.
TurnBasedMatch	setLastUpdateDetails(TurnBasedMatchModification lastUpdateDetails) Details about the last update to the match.
TurnBasedMatch	setMatchId(java.lang.String matchId) Globally unique ID for a turn-based match.
TurnBasedMatch	setMatchNumber(java.lang.Integer matchNumber) The number of the match in a chain of rematches.
TurnBasedMatch	setMatchVersion(java.lang.Integer matchVersion) The version of this match: an increasing counter, used to avoid out-of-date updates to the match.
TurnBasedMatch	setParticipants(java.util.List<TurnBasedMatchParticipant> participants) The participants involved in the match, along with their statuses.
TurnBasedMatch	setPendingParticipantId(java.lang.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(java.lang.String rematchId) The ID of a rematch of this match.
TurnBasedMatch	setResults(java.util.List<ParticipantResult> results) The results reported for this match.
TurnBasedMatch	setStatus(java.lang.String status) The status of the match.
TurnBasedMatch	setUserMatchStatus(java.lang.String userMatchStatus) The status of the current user in the match.
TurnBasedMatch	setVariant(java.lang.Integer variant) The variant / mode of the application being played; can be any integer value, or left blank.
TurnBasedMatch	setWithParticipantId(java.lang.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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

TurnBasedMatch

public TurnBasedMatch()

Method Detail

getApplicationId

public java.lang.String getApplicationId()

The ID of the application being played.

Returns:

value or null for none

setApplicationId

public TurnBasedMatch setApplicationId(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.String getMatchId()

Globally unique ID for a turn-based match.

Returns:

value or null for none

setMatchId

public TurnBasedMatch setMatchId(java.lang.String matchId)

Globally unique ID for a turn-based match.

Parameters:

matchId - matchId or null for none

getMatchNumber

public java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.util.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(java.util.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 java.lang.String getPendingParticipantId()

The ID of the participant that is taking a turn.

Returns:

value or null for none

setPendingParticipantId

public TurnBasedMatch setPendingParticipantId(java.lang.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 java.lang.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(java.lang.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 java.util.List<ParticipantResult> getResults()

The results reported for this match.

Returns:

value or null for none

setResults

public TurnBasedMatch setResults(java.util.List<ParticipantResult> results)

The results reported for this match.

Parameters:

results - results or null for none

getStatus

public java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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(java.lang.String fieldName,
                          java.lang.Object value)

Overrides:

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

clone

public TurnBasedMatch clone()

Overrides:

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