Class Room
This is a JSON template for a room resource object.
Inheritance
Implements
Namespace: Google.Apis.Games.v1.Data
Assembly: Google.Apis.Games.v1.dll
Syntax
public class Room : object, IDirectResponseSchemaProperties
ApplicationId
The ID of the application being played.
Declaration
public virtual string ApplicationId { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
AutoMatchingCriteria
Criteria for auto-matching players into this room.
Declaration
public virtual RoomAutoMatchingCriteria AutoMatchingCriteria { get; set; }Property Value
| Type | Description |
|---|---|
| RoomAutoMatchingCriteria |
AutoMatchingStatus
Auto-matching status for this room. Not set if the room is not currently in the auto-matching queue.
Declaration
public virtual RoomAutoMatchStatus AutoMatchingStatus { get; set; }Property Value
| Type | Description |
|---|---|
| RoomAutoMatchStatus |
CreationDetails
Details about the room creation.
Declaration
public virtual RoomModification CreationDetails { get; set; }Property Value
| Type | Description |
|---|---|
| RoomModification |
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.)
Declaration
public virtual string Description { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }Property Value
| Type | Description |
|---|---|
| System.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.
Declaration
public virtual string InviterId { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Kind
Uniquely identifies the type of this resource. Value is always the fixed string games#room.
Declaration
public virtual string Kind { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
LastUpdateDetails
Details about the last update to the room.
Declaration
public virtual RoomModification LastUpdateDetails { get; set; }Property Value
| Type | Description |
|---|---|
| RoomModification |
Participants
The participants involved in the room, along with their statuses. Includes participants who have left or declined invitations.
Declaration
public virtual IList<RoomParticipant> Participants { get; set; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<RoomParticipant> |
RoomId
Globally unique ID for a room.
Declaration
public virtual string RoomId { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
RoomStatusVersion
The version of the room status: an increasing counter, used by the client to ignore out-of-order updates to room status.
Declaration
public virtual Nullable<int> RoomStatusVersion { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
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.
Declaration
public virtual string Status { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Variant
The variant / mode of the application being played; can be any integer value, or left blank.
Declaration
public virtual Nullable<int> Variant { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |