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.


3840
3841
3842
# File 'generated/google/apis/games_v1/classes.rb', line 3840

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

Instance Attribute Details

#auto_matching_statusGoogle::Apis::GamesV1::RoomAutoMatchStatus

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


3803
3804
3805
# File 'generated/google/apis/games_v1/classes.rb', line 3803

def auto_matching_status
  @auto_matching_status
end

#kindString

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

Returns:

  • (String)

3809
3810
3811
# File 'generated/google/apis/games_v1/classes.rb', line 3809

def kind
  @kind
end

#participantsArray<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


3815
3816
3817
# File 'generated/google/apis/games_v1/classes.rb', line 3815

def participants
  @participants
end

#room_idString

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

Returns:

  • (String)

3820
3821
3822
# File 'generated/google/apis/games_v1/classes.rb', line 3820

def room_id
  @room_id
end

#statusString

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)

3832
3833
3834
# File 'generated/google/apis/games_v1/classes.rb', line 3832

def status
  @status
end

#status_versionFixnum

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)

3838
3839
3840
# File 'generated/google/apis/games_v1/classes.rb', line 3838

def status_version
  @status_version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


3845
3846
3847
3848
3849
3850
3851
3852
# File 'generated/google/apis/games_v1/classes.rb', line 3845

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