class Google::Apis::GamesV1::RoomStatus

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

Attributes

auto_matching_status[RW]

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]

kind[RW]

Uniquely identifies the type of this resource. Value is always the fixed string games#roomStatus. Corresponds to the JSON property `kind` @return [String]

participants[RW]

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>]

room_id[RW]

Globally unique ID for a room. Corresponds to the JSON property `roomId` @return [String]

status[RW]

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.

Corresponds to the JSON property `status` @return [String]

status_version[RW]

The version of the status for the room: an increasing counter, used by the client to ignore out-of-order updates to room status. Corresponds to the JSON property `statusVersion` @return [Fixnum]

Public Class Methods

new(**args) click to toggle source
# File generated/google/apis/games_v1/classes.rb, line 3806
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File generated/google/apis/games_v1/classes.rb, line 3811
def update!(**args)
  @auto_matching_status = args[:auto_matching_status] if args.key?(:auto_matching_status)
  @kind = args[:kind] if args.key?(:kind)
  @participants = args[:participants] if args.key?(:participants)
  @room_id = args[:room_id] if args.key?(:room_id)
  @status = args[:status] if args.key?(:status)
  @status_version = args[:status_version] if args.key?(:status_version)
end