com.google.api.services.games

Class Games.Rooms.Get

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

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Games.Rooms

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

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.Rooms.Get(String roomId) Get the data for a room.

Method Summary

Methods

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getLanguage() Specify the preferred language to use to format room info.
String	getRoomId() The ID of the room.
Games.Rooms.Get	set(String parameterName, Object value)
Games.Rooms.Get	setAlt(String alt) Data format for the response.
Games.Rooms.Get	setFields(String fields) Selector specifying which fields to include in a partial response.
Games.Rooms.Get	setKey(String key) API key.
Games.Rooms.Get	setLanguage(String language) Specify the preferred language to use to format room info.
Games.Rooms.Get	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Games.Rooms.Get	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Games.Rooms.Get	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Games.Rooms.Get	setRoomId(String roomId) The ID of the room.
Games.Rooms.Get	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.Rooms.Get

protected Games.Rooms.Get(String roomId)

Get the data for a room. Create a request for the method "rooms.get". 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.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<Room>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<Room>

Throws:

IOException

setAlt

public Games.Rooms.Get setAlt(String alt)

Description copied from class: GamesRequest

Data format for the response.

Overrides:

setAlt in class GamesRequest<Room>

setFields

public Games.Rooms.Get setFields(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.Get 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<Room>

setOauthToken

public Games.Rooms.Get setOauthToken(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.Get setPrettyPrint(Boolean prettyPrint)

Description copied from class: GamesRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class GamesRequest<Room>

setQuotaUser

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

setUserIp

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

getRoomId

public String getRoomId()

The ID of the room.

setRoomId

public Games.Rooms.Get setRoomId(String roomId)

The ID of the room.

getLanguage

public String getLanguage()

Specify the preferred language to use to format room info.

setLanguage

public Games.Rooms.Get setLanguage(String language)

Specify the preferred language to use to format room info.

set

public Games.Rooms.Get set(String parameterName,
                  Object value)

Overrides:

set in class GamesRequest<Room>