com.google.api.services.games

Class Games.TurnBasedMatches.LeaveTurn

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.games.GamesRequest<TurnBasedMatch>

com.google.api.services.games.Games.TurnBasedMatches.LeaveTurn

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Games.TurnBasedMatches

public class Games.TurnBasedMatches.LeaveTurn
extends GamesRequest<TurnBasedMatch>

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

Modifier	Constructor and Description
protected	Games.TurnBasedMatches.LeaveTurn(String matchId, Integer matchVersion) Leave a turn-based match during the current player's turn, without canceling the match.

Method Summary

Methods

Modifier and Type	Method and Description
String	getLanguage() The preferred language to use for strings returned by this method.
String	getMatchId() The ID of the match.
Integer	getMatchVersion() The version of the match being updated.
String	getPendingParticipantId() The ID of another participant who should take their turn next.
Games.TurnBasedMatches.LeaveTurn	set(String parameterName, Object value)
Games.TurnBasedMatches.LeaveTurn	setAlt(String alt) Data format for the response.
Games.TurnBasedMatches.LeaveTurn	setFields(String fields) Selector specifying which fields to include in a partial response.
Games.TurnBasedMatches.LeaveTurn	setKey(String key) API key.
Games.TurnBasedMatches.LeaveTurn	setLanguage(String language) The preferred language to use for strings returned by this method.
Games.TurnBasedMatches.LeaveTurn	setMatchId(String matchId) The ID of the match.
Games.TurnBasedMatches.LeaveTurn	setMatchVersion(Integer matchVersion) The version of the match being updated.
Games.TurnBasedMatches.LeaveTurn	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Games.TurnBasedMatches.LeaveTurn	setPendingParticipantId(String pendingParticipantId) The ID of another participant who should take their turn next.
Games.TurnBasedMatches.LeaveTurn	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Games.TurnBasedMatches.LeaveTurn	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Games.TurnBasedMatches.LeaveTurn	setUserIp(String userIp) IP address of the site where the request originates.

Methods inherited from class com.google.api.services.games.GamesRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

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

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

Methods inherited from class java.util.AbstractMap

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Games.TurnBasedMatches.LeaveTurn

protected Games.TurnBasedMatches.LeaveTurn(String matchId,
                                Integer matchVersion)

Leave a turn-based match during the current player's turn, without canceling the match. Create a request for the method "turnBasedMatches.leaveTurn". This request holds the parameters needed by the the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Games.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

matchId - The ID of the match.

matchVersion - The version of the match being updated.

Since:

1.13

Method Detail

setAlt

public Games.TurnBasedMatches.LeaveTurn setAlt(String alt)

Description copied from class: GamesRequest

Data format for the response.

Overrides:

setAlt in class GamesRequest<TurnBasedMatch>

setFields

public Games.TurnBasedMatches.LeaveTurn setFields(String fields)

Description copied from class: GamesRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class GamesRequest<TurnBasedMatch>

setKey

public Games.TurnBasedMatches.LeaveTurn setKey(String key)

Description copied from class: GamesRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class GamesRequest<TurnBasedMatch>

setOauthToken

public Games.TurnBasedMatches.LeaveTurn setOauthToken(String oauthToken)

Description copied from class: GamesRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class GamesRequest<TurnBasedMatch>

setPrettyPrint

public Games.TurnBasedMatches.LeaveTurn setPrettyPrint(Boolean prettyPrint)

Description copied from class: GamesRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class GamesRequest<TurnBasedMatch>

setQuotaUser

public Games.TurnBasedMatches.LeaveTurn setQuotaUser(String quotaUser)

Description copied from class: GamesRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

Overrides:

setQuotaUser in class GamesRequest<TurnBasedMatch>

setUserIp

public Games.TurnBasedMatches.LeaveTurn setUserIp(String userIp)

Description copied from class: GamesRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class GamesRequest<TurnBasedMatch>

getMatchId

public String getMatchId()

The ID of the match.

setMatchId

public Games.TurnBasedMatches.LeaveTurn setMatchId(String matchId)

The ID of the match.

getMatchVersion

public Integer getMatchVersion()

The version of the match being updated.

setMatchVersion

public Games.TurnBasedMatches.LeaveTurn setMatchVersion(Integer matchVersion)

The version of the match being updated.

getLanguage

public String getLanguage()

The preferred language to use for strings returned by this method.

setLanguage

public Games.TurnBasedMatches.LeaveTurn setLanguage(String language)

The preferred language to use for strings returned by this method.

getPendingParticipantId

public String getPendingParticipantId()

The ID of another participant who should take their turn next. If not set, the match will wait for other player(s) to join via automatching; this is only valid if automatch criteria is set on the match with remaining slots for automatched players.

setPendingParticipantId

public Games.TurnBasedMatches.LeaveTurn setPendingParticipantId(String pendingParticipantId)

The ID of another participant who should take their turn next. If not set, the match will wait for other player(s) to join via automatching; this is only valid if automatch criteria is set on the match with remaining slots for automatched players.

set

public Games.TurnBasedMatches.LeaveTurn set(String parameterName,
                                   Object value)

Overrides:

set in class GamesRequest<TurnBasedMatch>