com.google.api.services.games

Class Games.TurnBasedMatches.Sync

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<TurnBasedMatchSync>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Games.TurnBasedMatches

public class Games.TurnBasedMatches.Sync
extends GamesRequest<TurnBasedMatchSync>

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.Sync() Returns turn-based matches the player is or was involved in that changed since the last sync call, with the least recent changes coming first.

Method Summary

Methods

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
Boolean	getIncludeMatchData() True if match data should be returned in the response.
String	getLanguage() The preferred language to use for strings returned by this method.
Integer	getMaxCompletedMatches() The maximum number of completed or canceled matches to return in the response.
Integer	getMaxResults() The maximum number of matches to return in the response, used for paging.
String	getPageToken() The token returned by the previous request.
Games.TurnBasedMatches.Sync	set(String parameterName, Object value)
Games.TurnBasedMatches.Sync	setAlt(String alt) Data format for the response.
Games.TurnBasedMatches.Sync	setFields(String fields) Selector specifying which fields to include in a partial response.
Games.TurnBasedMatches.Sync	setIncludeMatchData(Boolean includeMatchData) True if match data should be returned in the response.
Games.TurnBasedMatches.Sync	setKey(String key) API key.
Games.TurnBasedMatches.Sync	setLanguage(String language) The preferred language to use for strings returned by this method.
Games.TurnBasedMatches.Sync	setMaxCompletedMatches(Integer maxCompletedMatches) The maximum number of completed or canceled matches to return in the response.
Games.TurnBasedMatches.Sync	setMaxResults(Integer maxResults) The maximum number of matches to return in the response, used for paging.
Games.TurnBasedMatches.Sync	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Games.TurnBasedMatches.Sync	setPageToken(String pageToken) The token returned by the previous request.
Games.TurnBasedMatches.Sync	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Games.TurnBasedMatches.Sync	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Games.TurnBasedMatches.Sync	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, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, 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.Sync

protected Games.TurnBasedMatches.Sync()

Returns turn-based matches the player is or was involved in that changed since the last sync call, with the least recent changes coming first. Matches that should be removed from the local cache will have a status of MATCH_DELETED. Create a request for the method "turnBasedMatches.sync". 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.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<TurnBasedMatchSync>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<TurnBasedMatchSync>

Throws:

IOException

setAlt

public Games.TurnBasedMatches.Sync setAlt(String alt)

Description copied from class: GamesRequest

Data format for the response.

Overrides:

setAlt in class GamesRequest<TurnBasedMatchSync>

setFields

public Games.TurnBasedMatches.Sync setFields(String fields)

Description copied from class: GamesRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class GamesRequest<TurnBasedMatchSync>

setKey

public Games.TurnBasedMatches.Sync 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<TurnBasedMatchSync>

setOauthToken

public Games.TurnBasedMatches.Sync setOauthToken(String oauthToken)

Description copied from class: GamesRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class GamesRequest<TurnBasedMatchSync>

setPrettyPrint

public Games.TurnBasedMatches.Sync setPrettyPrint(Boolean prettyPrint)

Description copied from class: GamesRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class GamesRequest<TurnBasedMatchSync>

setQuotaUser

public Games.TurnBasedMatches.Sync 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<TurnBasedMatchSync>

setUserIp

public Games.TurnBasedMatches.Sync 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<TurnBasedMatchSync>

getPageToken

public String getPageToken()

The token returned by the previous request.

setPageToken

public Games.TurnBasedMatches.Sync setPageToken(String pageToken)

The token returned by the previous request.

getMaxCompletedMatches

public Integer getMaxCompletedMatches()

The maximum number of completed or canceled matches to return in the response. If not set, all matches returned could be completed or canceled. [minimum: 0] [maximum: 500]

setMaxCompletedMatches

public Games.TurnBasedMatches.Sync setMaxCompletedMatches(Integer maxCompletedMatches)

The maximum number of completed or canceled matches to return in the response. If not set, all matches returned could be completed or canceled.

getMaxResults

public Integer getMaxResults()

The maximum number of matches to return in the response, used for paging. For any response, the actual number of matches to return may be less than the specified maxResults. [minimum: 1] [maximum: 500]

setMaxResults

public Games.TurnBasedMatches.Sync setMaxResults(Integer maxResults)

The maximum number of matches to return in the response, used for paging. For any response, the actual number of matches to return may be less than the specified maxResults.

getLanguage

public String getLanguage()

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

setLanguage

public Games.TurnBasedMatches.Sync setLanguage(String language)

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

getIncludeMatchData

public Boolean getIncludeMatchData()

True if match data should be returned in the response. Note that not all data will necessarily be returned if include_match_data is true; the server may decide to only return data for some of the matches to limit download size for the client. The remainder of the data for these matches will be retrievable on request.

setIncludeMatchData

public Games.TurnBasedMatches.Sync setIncludeMatchData(Boolean includeMatchData)

True if match data should be returned in the response. Note that not all data will necessarily be returned if include_match_data is true; the server may decide to only return data for some of the matches to limit download size for the client. The remainder of the data for these matches will be retrievable on request.

set

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

Overrides:

set in class GamesRequest<TurnBasedMatchSync>