Class: Google::Apis::GamesV1::RoomStatus

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/games_v1/classes.rb,
generated/google/apis/games_v1/representations.rb,
generated/google/apis/games_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ RoomStatus

Returns a new instance of RoomStatus.



3555
3556
3557
 
# File 'generated/google/apis/games_v1/classes.rb', line 3555

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#auto_matching_status ⇒ Google::Apis::GamesV1::RoomAutoMatchStatus

This is a JSON template for status of room automatching that is in progress. Corresponds to the JSON property autoMatchingStatus

Returns:



3518
3519
3520
 
# File 'generated/google/apis/games_v1/classes.rb', line 3518

def auto_matching_status
  @auto_matching_status
end

#kind ⇒ String

Uniquely identifies the type of this resource. Value is always the fixed string games#roomStatus. Corresponds to the JSON property kind

Returns:

  • (String) 


3524
3525
3526
 
# File 'generated/google/apis/games_v1/classes.rb', line 3524

def kind
  @kind
end

#participants ⇒ Array<Google::Apis::GamesV1::RoomParticipant>

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

Returns:



3530
3531
3532
 
# File 'generated/google/apis/games_v1/classes.rb', line 3530

def participants
  @participants
end

#room_id ⇒ String

Globally unique ID for a room. Corresponds to the JSON property roomId

Returns:

  • (String) 


3535
3536
3537
 
# File 'generated/google/apis/games_v1/classes.rb', line 3535

def room_id
  @room_id
end

#status ⇒ String

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

Returns:

  • (String) 


3547
3548
3549
 
# File 'generated/google/apis/games_v1/classes.rb', line 3547

def status
  @status
end

#status_version ⇒ Fixnum

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

Returns:

  • (Fixnum) 


3553
3554
3555
 
# File 'generated/google/apis/games_v1/classes.rb', line 3553

def status_version
  @status_version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3560
3561
3562
3563
3564
3565
3566
3567
 
# File 'generated/google/apis/games_v1/classes.rb', line 3560

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