com.google.api.services.games.model

Class RoomStatus

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.games.model.RoomStatus

All Implemented Interfaces:

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

public final class RoomStatus
extends com.google.api.client.json.GenericJson

This is a JSON template for the status of a room that the player has joined.

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

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>

Constructor Summary

Constructors

Constructor and Description
RoomStatus()

Method Summary

Methods

Modifier and Type	Method and Description
RoomStatus	clone()
RoomAutoMatchStatus	getAutoMatchingStatus() Auto-matching status for this room.
java.lang.String	getKind() Uniquely identifies the type of this resource.
java.util.List<RoomParticipant>	getParticipants() The participants involved in the room, along with their statuses.
java.lang.String	getRoomId() Globally unique ID for a room.
java.lang.String	getStatus() The status of the room.
java.lang.Integer	getStatusVersion() The version of the status for the room: an increasing counter, used by the client to ignore out-of-order updates to room status.
RoomStatus	set(java.lang.String fieldName, java.lang.Object value)
RoomStatus	setAutoMatchingStatus(RoomAutoMatchStatus autoMatchingStatus) Auto-matching status for this room.
RoomStatus	setKind(java.lang.String kind) Uniquely identifies the type of this resource.
RoomStatus	setParticipants(java.util.List<RoomParticipant> participants) The participants involved in the room, along with their statuses.
RoomStatus	setRoomId(java.lang.String roomId) Globally unique ID for a room.
RoomStatus	setStatus(java.lang.String status) The status of the room.
RoomStatus	setStatusVersion(java.lang.Integer statusVersion) The version of the status for the room: an increasing counter, used by the client to ignore out-of-order updates to room status.

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

RoomStatus

public RoomStatus()

Method Detail

getAutoMatchingStatus

public RoomAutoMatchStatus getAutoMatchingStatus()

Auto-matching status for this room. Not set if the room is not currently in the automatching queue.

Returns:

value or null for none

setAutoMatchingStatus

public RoomStatus setAutoMatchingStatus(RoomAutoMatchStatus autoMatchingStatus)

Auto-matching status for this room. Not set if the room is not currently in the automatching queue.

Parameters:

autoMatchingStatus - autoMatchingStatus or null for none

getKind

public java.lang.String getKind()

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

Returns:

value or null for none

setKind

public RoomStatus setKind(java.lang.String kind)

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

Parameters:

kind - kind or null for none

getParticipants

public java.util.List<RoomParticipant> getParticipants()

The participants involved in the room, along with their statuses. Includes participants who have left or declined invitations.

Returns:

value or null for none

setParticipants

public RoomStatus setParticipants(java.util.List<RoomParticipant> participants)

The participants involved in the room, along with their statuses. Includes participants who have left or declined invitations.

Parameters:

participants - participants or null for none

getRoomId

public java.lang.String getRoomId()

Globally unique ID for a room.

Returns:

value or null for none

setRoomId

public RoomStatus setRoomId(java.lang.String roomId)

Globally unique ID for a room.

Parameters:

roomId - roomId or null for none

getStatus

public java.lang.String getStatus()

The status of the room. Possible values are: - "ROOM_INVITING" - One or more players have been invited and not responded. - "ROOM_AUTO_MATCHING" - One or more slots need to be filled by auto-matching. - "ROOM_CONNECTING" - Players have joined are connecting to each other (either before or after auto-matching). - "ROOM_ACTIVE" - All players have joined and connected to each other. - "ROOM_DELETED" - All joined players have left.

Returns:

value or null for none

setStatus

public RoomStatus setStatus(java.lang.String status)

The status of the room. Possible values are: - "ROOM_INVITING" - One or more players have been invited and not responded. - "ROOM_AUTO_MATCHING" - One or more slots need to be filled by auto-matching. - "ROOM_CONNECTING" - Players have joined are connecting to each other (either before or after auto-matching). - "ROOM_ACTIVE" - All players have joined and connected to each other. - "ROOM_DELETED" - All joined players have left.

Parameters:

status - status or null for none

getStatusVersion

public java.lang.Integer getStatusVersion()

The version of the status for the room: an increasing counter, used by the client to ignore out-of-order updates to room status.

Returns:

value or null for none

setStatusVersion

public RoomStatus setStatusVersion(java.lang.Integer statusVersion)

The version of the status for the room: an increasing counter, used by the client to ignore out-of-order updates to room status.

Parameters:

statusVersion - statusVersion or null for none

set

public RoomStatus set(java.lang.String fieldName,
             java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public RoomStatus clone()

Overrides:

clone in class com.google.api.client.json.GenericJson