class Google::Apis::GamesV1::Room
This is a JSON template for a room resource object.
Attributes
The ID of the application being played. Corresponds to the JSON property `applicationId` @return [String]
This is a JSON template for a room auto-match criteria object. Corresponds to the JSON property `autoMatchingCriteria` @return [Google::Apis::GamesV1::RoomAutoMatchingCriteria]
This is a JSON template for status of room automatching that is in progress. Corresponds to the JSON property `autoMatchingStatus` @return [Google::Apis::GamesV1::RoomAutoMatchStatus]
This is a JSON template for room modification metadata. Corresponds to the JSON property `creationDetails` @return [Google::Apis::GamesV1::RoomModification]
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.) Corresponds to the JSON property `description` @return [String]
The ID of the participant that invited the user to the room. Not set if the user was not invited to the room. Corresponds to the JSON property `inviterId` @return [String]
Uniquely identifies the type of this resource. Value is always the fixed string games#room. Corresponds to the JSON property `kind` @return [String]
This is a JSON template for room modification metadata. Corresponds to the JSON property `lastUpdateDetails` @return [Google::Apis::GamesV1::RoomModification]
The participants involved in the room, along with their statuses. Includes participants who have left or declined invitations. Corresponds to the JSON property `participants` @return [Array<Google::Apis::GamesV1::RoomParticipant>]
Globally unique ID for a room. Corresponds to the JSON property `roomId` @return [String]
The version of the room status: an increasing counter, used by the client to ignore out-of-order updates to room status. Corresponds to the JSON property `roomStatusVersion` @return [Fixnum]
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. Corresponds to the JSON property `status` @return [String]
The variant / mode of the application being played; can be any integer value, or left blank. Corresponds to the JSON property `variant` @return [Fixnum]
Public Class Methods
# File generated/google/apis/games_v1/classes.rb, line 3158 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File generated/google/apis/games_v1/classes.rb, line 3163 def update!(**args) @application_id = args[:application_id] if args.key?(:application_id) @auto_matching_criteria = args[:auto_matching_criteria] if args.key?(:auto_matching_criteria) @auto_matching_status = args[:auto_matching_status] if args.key?(:auto_matching_status) @creation_details = args[:creation_details] if args.key?(:creation_details) @description = args[:description] if args.key?(:description) @inviter_id = args[:inviter_id] if args.key?(:inviter_id) @kind = args[:kind] if args.key?(:kind) @last_update_details = args[:last_update_details] if args.key?(:last_update_details) @participants = args[:participants] if args.key?(:participants) @room_id = args[:room_id] if args.key?(:room_id) @room_status_version = args[:room_status_version] if args.key?(:room_status_version) @status = args[:status] if args.key?(:status) @variant = args[:variant] if args.key?(:variant) end