com.google.api.services.games

Class Games.Rooms.Join

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

com.google.api.services.games.Games.Rooms.Join

All Implemented Interfaces:

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

Enclosing class:

Games.Rooms

public class Games.Rooms.Join
extends GamesRequest<Room>

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.Rooms.Join(java.lang.String roomId, RoomJoinRequest content) Join a room.

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

protected Games.Rooms.Join(java.lang.String roomId,
                RoomJoinRequest content)

Join a room. For internal use by the Games SDK only. Calling this method directly is unsupported. Create a request for the method "rooms.join". 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:

roomId - The ID of the room.

content - the RoomJoinRequest

Since:

1.13

Method Detail

setAlt

public Games.Rooms.Join setAlt(java.lang.String alt)

Description copied from class: GamesRequest

Data format for the response.

Overrides:

setAlt in class GamesRequest<Room>

setFields

public Games.Rooms.Join 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<Room>

setKey

public Games.Rooms.Join 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<Room>

setOauthToken

public Games.Rooms.Join setOauthToken(java.lang.String oauthToken)

Description copied from class: GamesRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class GamesRequest<Room>

setPrettyPrint

public Games.Rooms.Join setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: GamesRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class GamesRequest<Room>

setQuotaUser

public Games.Rooms.Join 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<Room>

setUserIp

public Games.Rooms.Join 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<Room>

getRoomId

public java.lang.String getRoomId()

The ID of the room.

setRoomId

public Games.Rooms.Join setRoomId(java.lang.String roomId)

The ID of the room.

getConsistencyToken

public java.lang.Long getConsistencyToken()

The last-seen mutation timestamp.

setConsistencyToken

public Games.Rooms.Join 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.Rooms.Join setLanguage(java.lang.String language)

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

set

public Games.Rooms.Join set(java.lang.String parameterName,
                   java.lang.Object value)

Overrides:

set in class GamesRequest<Room>