Class: Google::Apis::GamesV1::Room

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 a room resource object.

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) ⇒ Room

Returns a new instance of Room



3193
3194
3195
 
# File 'generated/google/apis/games_v1/classes.rb', line 3193

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

Instance Attribute Details

#application_id ⇒ String

The ID of the application being played. Corresponds to the JSON property applicationId

Returns:

  • (String) 


3115
3116
3117
 
# File 'generated/google/apis/games_v1/classes.rb', line 3115

def application_id
  @application_id
end

#auto_matching_criteria ⇒ Google::Apis::GamesV1::RoomAutoMatchingCriteria

This is a JSON template for a room auto-match criteria object. Corresponds to the JSON property autoMatchingCriteria

Returns:



3120
3121
3122
 
# File 'generated/google/apis/games_v1/classes.rb', line 3120

def auto_matching_criteria
  @auto_matching_criteria
end

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



3125
3126
3127
 
# File 'generated/google/apis/games_v1/classes.rb', line 3125

def auto_matching_status
  @auto_matching_status
end

#creation_details ⇒ Google::Apis::GamesV1::RoomModification

This is a JSON template for room modification metadata. Corresponds to the JSON property creationDetails

Returns:



3130
3131
3132
 
# File 'generated/google/apis/games_v1/classes.rb', line 3130

def creation_details
  @creation_details
end

#description ⇒ String

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

Returns:

  • (String) 


3137
3138
3139
 
# File 'generated/google/apis/games_v1/classes.rb', line 3137

def description
  @description
end

#inviter_id ⇒ 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

Returns:

  • (String) 


3143
3144
3145
 
# File 'generated/google/apis/games_v1/classes.rb', line 3143

def inviter_id
  @inviter_id
end

#kind ⇒ String

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

Returns:

  • (String) 


3149
3150
3151
 
# File 'generated/google/apis/games_v1/classes.rb', line 3149

def kind
  @kind
end

#last_update_details ⇒ Google::Apis::GamesV1::RoomModification

This is a JSON template for room modification metadata. Corresponds to the JSON property lastUpdateDetails

Returns:



3154
3155
3156
 
# File 'generated/google/apis/games_v1/classes.rb', line 3154

def last_update_details
  @last_update_details
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:



3160
3161
3162
 
# File 'generated/google/apis/games_v1/classes.rb', line 3160

def participants
  @participants
end

#room_id ⇒ String

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

Returns:

  • (String) 


3165
3166
3167
 
# File 'generated/google/apis/games_v1/classes.rb', line 3165

def room_id
  @room_id
end

#room_status_version ⇒ Fixnum

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

Returns:

  • (Fixnum) 


3171
3172
3173
 
# File 'generated/google/apis/games_v1/classes.rb', line 3171

def room_status_version
  @room_status_version
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 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

Returns:

  • (String) 


3185
3186
3187
 
# File 'generated/google/apis/games_v1/classes.rb', line 3185

def status
  @status
end

#variant ⇒ Fixnum

The variant / mode of the application being played; can be any integer value, or left blank. Corresponds to the JSON property variant

Returns:

  • (Fixnum) 


3191
3192
3193
 
# File 'generated/google/apis/games_v1/classes.rb', line 3191

def variant
  @variant
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
 
# File 'generated/google/apis/games_v1/classes.rb', line 3198

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