com.google.api.services.games

Class Games.TurnBasedMatches.Finish

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.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.Finish

All Implemented Interfaces:

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

Enclosing class:

Games.TurnBasedMatches

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

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>

Field Summary

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

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Games.TurnBasedMatches.Finish(java.lang.String matchId, TurnBasedMatchResults content) Finish a turn-based match.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Long	getConsistencyToken() The last-seen mutation timestamp.
java.lang.String	getLanguage() The preferred language to use for strings returned by this method.
java.lang.String	getMatchId() The ID of the match.
Games.TurnBasedMatches.Finish	set(java.lang.String parameterName, java.lang.Object value)
Games.TurnBasedMatches.Finish	setAlt(java.lang.String alt) Data format for the response.
Games.TurnBasedMatches.Finish	setConsistencyToken(java.lang.Long consistencyToken) The last-seen mutation timestamp.
Games.TurnBasedMatches.Finish	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
Games.TurnBasedMatches.Finish	setKey(java.lang.String key) API key.
Games.TurnBasedMatches.Finish	setLanguage(java.lang.String language) The preferred language to use for strings returned by this method.
Games.TurnBasedMatches.Finish	setMatchId(java.lang.String matchId) The ID of the match.
Games.TurnBasedMatches.Finish	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
Games.TurnBasedMatches.Finish	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
Games.TurnBasedMatches.Finish	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
Games.TurnBasedMatches.Finish	setUserIp(java.lang.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.Finish

protected Games.TurnBasedMatches.Finish(java.lang.String matchId,
                             TurnBasedMatchResults content)

Finish a turn-based match. Each player should make this call once, after all results are in. Only the player whose turn it is may make the first call to Finish, and can pass in the final match state. Create a request for the method "turnBasedMatches.finish". 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.

content - the TurnBasedMatchResults

Since:

1.13

Method Detail

setAlt

public Games.TurnBasedMatches.Finish setAlt(java.lang.String alt)

Description copied from class: GamesRequest

Data format for the response.

Overrides:

setAlt in class GamesRequest<TurnBasedMatch>

setFields

public Games.TurnBasedMatches.Finish setFields(java.lang.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.Finish setKey(java.lang.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.Finish setOauthToken(java.lang.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.Finish setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: GamesRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class GamesRequest<TurnBasedMatch>

setQuotaUser

public Games.TurnBasedMatches.Finish setQuotaUser(java.lang.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.Finish setUserIp(java.lang.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 java.lang.String getMatchId()

The ID of the match.

setMatchId

public Games.TurnBasedMatches.Finish setMatchId(java.lang.String matchId)

The ID of the match.

getConsistencyToken

public java.lang.Long getConsistencyToken()

The last-seen mutation timestamp.

setConsistencyToken

public Games.TurnBasedMatches.Finish setConsistencyToken(java.lang.Long consistencyToken)

The last-seen mutation timestamp.

getLanguage

public java.lang.String getLanguage()

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

setLanguage

public Games.TurnBasedMatches.Finish setLanguage(java.lang.String language)

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

set

public Games.TurnBasedMatches.Finish set(java.lang.String parameterName,
                                java.lang.Object value)

Overrides:

set in class GamesRequest<TurnBasedMatch>