com.google.api.services.games.model

Class RoomCreateRequest

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.games.model.RoomCreateRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class RoomCreateRequest
extends GenericJson

This is a JSON template for a room creation request.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Play Game Services API. For a detailed explanation see: http://code.google.com/p/google-http-java-client/wiki/JSON

Author:

Google, Inc.

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

Constructor and Description
RoomCreateRequest()

Method Summary

Methods

Modifier and Type	Method and Description
RoomCreateRequest	clone()
RoomAutoMatchingCriteria	getAutoMatchingCriteria() Criteria for auto-matching players into this room.
List<String>	getCapabilities() The capabilities that this client supports for realtime communication.
RoomClientAddress	getClientAddress() Client address for the player creating the room.
List<String>	getInvitedPlayerIds() The player IDs to invite to the room.
String	getKind() Uniquely identifies the type of this resource.
NetworkDiagnostics	getNetworkDiagnostics() Network diagnostics for the client creating the room.
Long	getRequestId() A randomly generated numeric ID.
Integer	getVariant() The variant / mode of the application to be played.
RoomCreateRequest	set(String fieldName, Object value)
RoomCreateRequest	setAutoMatchingCriteria(RoomAutoMatchingCriteria autoMatchingCriteria) Criteria for auto-matching players into this room.
RoomCreateRequest	setCapabilities(List<String> capabilities) The capabilities that this client supports for realtime communication.
RoomCreateRequest	setClientAddress(RoomClientAddress clientAddress) Client address for the player creating the room.
RoomCreateRequest	setInvitedPlayerIds(List<String> invitedPlayerIds) The player IDs to invite to the room.
RoomCreateRequest	setKind(String kind) Uniquely identifies the type of this resource.
RoomCreateRequest	setNetworkDiagnostics(NetworkDiagnostics networkDiagnostics) Network diagnostics for the client creating the room.
RoomCreateRequest	setRequestId(Long requestId) A randomly generated numeric ID.
RoomCreateRequest	setVariant(Integer variant) The variant / mode of the application to be played.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

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

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

Methods inherited from class java.util.AbstractMap

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RoomCreateRequest

public RoomCreateRequest()

Method Detail

getAutoMatchingCriteria

public RoomAutoMatchingCriteria getAutoMatchingCriteria()

Criteria for auto-matching players into this room.

Returns:

value or null for none

setAutoMatchingCriteria

public RoomCreateRequest setAutoMatchingCriteria(RoomAutoMatchingCriteria autoMatchingCriteria)

Criteria for auto-matching players into this room.

Parameters:

autoMatchingCriteria - autoMatchingCriteria or null for none

getCapabilities

public List<String> getCapabilities()

The capabilities that this client supports for realtime communication.

Returns:

value or null for none

setCapabilities

public RoomCreateRequest setCapabilities(List<String> capabilities)

The capabilities that this client supports for realtime communication.

Parameters:

capabilities - capabilities or null for none

getClientAddress

public RoomClientAddress getClientAddress()

Client address for the player creating the room.

Returns:

value or null for none

setClientAddress

public RoomCreateRequest setClientAddress(RoomClientAddress clientAddress)

Client address for the player creating the room.

Parameters:

clientAddress - clientAddress or null for none

getInvitedPlayerIds

public List<String> getInvitedPlayerIds()

The player IDs to invite to the room.

Returns:

value or null for none

setInvitedPlayerIds

public RoomCreateRequest setInvitedPlayerIds(List<String> invitedPlayerIds)

The player IDs to invite to the room.

Parameters:

invitedPlayerIds - invitedPlayerIds or null for none

getKind

public String getKind()

Uniquely identifies the type of this resource. Value is always the fixed string games#roomCreateRequest.

Returns:

value or null for none

setKind

public RoomCreateRequest setKind(String kind)

Uniquely identifies the type of this resource. Value is always the fixed string games#roomCreateRequest.

Parameters:

kind - kind or null for none

getNetworkDiagnostics

public NetworkDiagnostics getNetworkDiagnostics()

Network diagnostics for the client creating the room.

Returns:

value or null for none

setNetworkDiagnostics

public RoomCreateRequest setNetworkDiagnostics(NetworkDiagnostics networkDiagnostics)

Network diagnostics for the client creating the room.

Parameters:

networkDiagnostics - networkDiagnostics or null for none

getRequestId

public Long getRequestId()

A randomly generated numeric ID. This number is used at the server to ensure that the request is handled correctly across retries.

Returns:

value or null for none

setRequestId

public RoomCreateRequest setRequestId(Long requestId)

A randomly generated numeric ID. This number is used at the server to ensure that the request is handled correctly across retries.

Parameters:

requestId - requestId or null for none

getVariant

public Integer getVariant()

The variant / mode of the application to be played. This can be any integer value, or left blank. You should use a small number of variants to keep the auto-matching pool as large as possible.

Returns:

value or null for none

setVariant

public RoomCreateRequest setVariant(Integer variant)

The variant / mode of the application to be played. This can be any integer value, or left blank. You should use a small number of variants to keep the auto-matching pool as large as possible.

Parameters:

variant - variant or null for none

set

public RoomCreateRequest set(String fieldName,
                    Object value)

Overrides:

set in class GenericJson

clone

public RoomCreateRequest clone()

Overrides:

clone in class GenericJson