Class: Google::Apis::GamesV1::LeaveRoomRequest

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 leave room request.

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

Returns a new instance of LeaveRoomRequest.



3247
3248
3249
# File 'generated/google/apis/games_v1/classes.rb', line 3247

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

Instance Attribute Details

#kindString

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

Returns:

  • (String)


3214
3215
3216
# File 'generated/google/apis/games_v1/classes.rb', line 3214

def kind
  @kind
end

#leave_diagnosticsGoogle::Apis::GamesV1::RoomLeaveDiagnostics

This is a JSON template for room leave diagnostics. Corresponds to the JSON property leaveDiagnostics



3219
3220
3221
# File 'generated/google/apis/games_v1/classes.rb', line 3219

def leave_diagnostics
  @leave_diagnostics
end

#reasonString

Reason for leaving the match. Possible values are:

  • "PLAYER_LEFT" - The player chose to leave the room..
  • "GAME_LEFT" - The game chose to remove the player from the room.
  • "REALTIME_ABANDONED" - The player switched to another application and abandoned the room.
  • "REALTIME_PEER_CONNECTION_FAILURE" - The client was unable to establish a connection to other peer(s).
  • "REALTIME_SERVER_CONNECTION_FAILURE" - The client was unable to communicate with the server.
  • "REALTIME_SERVER_ERROR" - The client received an error response when it tried to communicate with the server.
  • "REALTIME_TIMEOUT" - The client timed out while waiting for a room.
  • "REALTIME_CLIENT_DISCONNECTING" - The client disconnects without first calling Leave.
  • "REALTIME_SIGN_OUT" - The user signed out of G+ while in the room.
  • "REALTIME_GAME_CRASHED" - The game crashed.
  • "REALTIME_ROOM_SERVICE_CRASHED" - RoomAndroidService crashed.
  • "REALTIME_DIFFERENT_CLIENT_ROOM_OPERATION" - Another client is trying to enter a room.
  • "REALTIME_SAME_CLIENT_ROOM_OPERATION" - The same client is trying to enter a new room. Corresponds to the JSON property reason

Returns:

  • (String)


3245
3246
3247
# File 'generated/google/apis/games_v1/classes.rb', line 3245

def reason
  @reason
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3252
3253
3254
3255
3256
# File 'generated/google/apis/games_v1/classes.rb', line 3252

def update!(**args)
  @kind = args[:kind] if args.key?(:kind)
  @leave_diagnostics = args[:leave_diagnostics] if args.key?(:leave_diagnostics)
  @reason = args[:reason] if args.key?(:reason)
end