com.google.api.services.games.model

Class Room

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Room
extends GenericJson

This is a JSON template for a room resource object.

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: https://developers.google.com/api-client-library/java/google-http-java-client/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
Room()

Method Summary

Modifier and Type	Method and Description
Room	clone()
String	getApplicationId() The ID of the application being played.
RoomAutoMatchingCriteria	getAutoMatchingCriteria() Criteria for auto-matching players into this room.
RoomAutoMatchStatus	getAutoMatchingStatus() Auto-matching status for this room.
RoomModification	getCreationDetails() Details about the room creation.
String	getDescription() This short description is generated by our servers and worded relative to the player requesting the room.
String	getInviterId() The ID of the participant that invited the user to the room.
String	getKind() Uniquely identifies the type of this resource.
RoomModification	getLastUpdateDetails() Details about the last update to the room.
List<RoomParticipant>	getParticipants() The participants involved in the room, along with their statuses.
String	getRoomId() Globally unique ID for a room.
Integer	getRoomStatusVersion() The version of the room status: an increasing counter, used by the client to ignore out-of- order updates to room status.
String	getStatus() The status of the room.
Integer	getVariant() The variant / mode of the application being played; can be any integer value, or left blank.
Room	set(String fieldName, Object value)
Room	setApplicationId(String applicationId) The ID of the application being played.
Room	setAutoMatchingCriteria(RoomAutoMatchingCriteria autoMatchingCriteria) Criteria for auto-matching players into this room.
Room	setAutoMatchingStatus(RoomAutoMatchStatus autoMatchingStatus) Auto-matching status for this room.
Room	setCreationDetails(RoomModification creationDetails) Details about the room creation.
Room	setDescription(String description) This short description is generated by our servers and worded relative to the player requesting the room.
Room	setInviterId(String inviterId) The ID of the participant that invited the user to the room.
Room	setKind(String kind) Uniquely identifies the type of this resource.
Room	setLastUpdateDetails(RoomModification lastUpdateDetails) Details about the last update to the room.
Room	setParticipants(List<RoomParticipant> participants) The participants involved in the room, along with their statuses.
Room	setRoomId(String roomId) Globally unique ID for a room.
Room	setRoomStatusVersion(Integer roomStatusVersion) The version of the room status: an increasing counter, used by the client to ignore out-of- order updates to room status.
Room	setStatus(String status) The status of the room.
Room	setVariant(Integer variant) The variant / mode of the application being played; can be any integer value, or left blank.

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, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Room

public Room()

Method Detail

getApplicationId

public String getApplicationId()

The ID of the application being played.

Returns:

value or null for none

setApplicationId

public Room setApplicationId(String applicationId)

The ID of the application being played.

Parameters:

applicationId - applicationId or null for none

getAutoMatchingCriteria

public RoomAutoMatchingCriteria getAutoMatchingCriteria()

Criteria for auto-matching players into this room.

Returns:

value or null for none

setAutoMatchingCriteria

public Room setAutoMatchingCriteria(RoomAutoMatchingCriteria autoMatchingCriteria)

Criteria for auto-matching players into this room.

Parameters:

autoMatchingCriteria - autoMatchingCriteria or null for none

getAutoMatchingStatus

public RoomAutoMatchStatus getAutoMatchingStatus()

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

Returns:

value or null for none

setAutoMatchingStatus

public Room setAutoMatchingStatus(RoomAutoMatchStatus autoMatchingStatus)

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

Parameters:

autoMatchingStatus - autoMatchingStatus or null for none

getCreationDetails

public RoomModification getCreationDetails()

Details about the room creation.

Returns:

value or null for none

setCreationDetails

public Room setCreationDetails(RoomModification creationDetails)

Details about the room creation.

Parameters:

creationDetails - creationDetails or null for none

getDescription

public String getDescription()

This short description is generated by our servers and worded relative to the player requesting the room. It is intended to be displayed when the room is shown in a list (that is, an invitation to a room.)

Returns:

value or null for none

setDescription

public Room setDescription(String description)

This short description is generated by our servers and worded relative to the player requesting the room. It is intended to be displayed when the room is shown in a list (that is, an invitation to a room.)

Parameters:

description - description or null for none

getInviterId

public String getInviterId()

The ID of the participant that invited the user to the room. Not set if the user was not invited to the room.

Returns:

value or null for none

setInviterId

public Room setInviterId(String inviterId)

The ID of the participant that invited the user to the room. Not set if the user was not invited to the room.

Parameters:

inviterId - inviterId or null for none

getKind

public String getKind()

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

Returns:

value or null for none

setKind

public Room setKind(String kind)

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

Parameters:

kind - kind or null for none

getLastUpdateDetails

public RoomModification getLastUpdateDetails()

Details about the last update to the room.

Returns:

value or null for none

setLastUpdateDetails

public Room setLastUpdateDetails(RoomModification lastUpdateDetails)

Details about the last update to the room.

Parameters:

lastUpdateDetails - lastUpdateDetails or null for none

getParticipants

public 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 Room setParticipants(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 String getRoomId()

Globally unique ID for a room.

Returns:

value or null for none

setRoomId

public Room setRoomId(String roomId)

Globally unique ID for a room.

Parameters:

roomId - roomId or null for none

getRoomStatusVersion

public Integer getRoomStatusVersion()

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

Returns:

value or null for none

setRoomStatusVersion

public Room setRoomStatusVersion(Integer roomStatusVersion)

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

Parameters:

roomStatusVersion - roomStatusVersion or null for none

getStatus

public 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 and are connecting to each other (either before or after auto-matching). - "ROOM_ACTIVE" - All players have joined and connected to each other. - "ROOM_DELETED" - The room should no longer be shown on the client. Returned in sync calls when a player joins a room (as a tombstone), or for rooms where all joined participants have left.

Returns:

value or null for none

setStatus

public Room setStatus(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 and are connecting to each other (either before or after auto-matching). - "ROOM_ACTIVE" - All players have joined and connected to each other. - "ROOM_DELETED" - The room should no longer be shown on the client. Returned in sync calls when a player joins a room (as a tombstone), or for rooms where all joined participants have left.

Parameters:

status - status or null for none

getVariant

public Integer getVariant()

The variant / mode of the application being played; can be any integer value, or left blank.

Returns:

value or null for none

setVariant

public Room setVariant(Integer variant)

The variant / mode of the application being played; can be any integer value, or left blank.

Parameters:

variant - variant or null for none

set

public Room set(String fieldName,
                Object value)

Overrides:

set in class GenericJson

clone

public Room clone()

Overrides:

clone in class GenericJson