Class: Google::Apis::GamesV1::CreateTurnBasedMatchRequest

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 turn-based match creation 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) ⇒ CreateTurnBasedMatchRequest

Returns a new instance of CreateTurnBasedMatchRequest.


4300
4301
4302
# File 'generated/google/apis/games_v1/classes.rb', line 4300

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

Instance Attribute Details

#auto_matching_criteriaGoogle::Apis::GamesV1::TurnBasedAutoMatchingCriteria

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


4274
4275
4276
# File 'generated/google/apis/games_v1/classes.rb', line 4274

def auto_matching_criteria
  @auto_matching_criteria
end

#invited_player_idsArray<String>

The player ids to invite to the match. Corresponds to the JSON property invitedPlayerIds

Returns:

  • (Array<String>)

4279
4280
4281
# File 'generated/google/apis/games_v1/classes.rb', line 4279

def invited_player_ids
  @invited_player_ids
end

#kindString

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

Returns:

  • (String)

4285
4286
4287
# File 'generated/google/apis/games_v1/classes.rb', line 4285

def kind
  @kind
end

#request_idString

A randomly generated numeric ID. This number is used at the server to ensure that the request is handled correctly across retries. Corresponds to the JSON property requestId

Returns:

  • (String)

4291
4292
4293
# File 'generated/google/apis/games_v1/classes.rb', line 4291

def request_id
  @request_id
end

#variantFixnum

The variant / mode of the application to be played. This can be any integer value, or left blank. You should use a small number of variants to keep the auto-matching pool as large as possible. Corresponds to the JSON property variant

Returns:

  • (Fixnum)

4298
4299
4300
# File 'generated/google/apis/games_v1/classes.rb', line 4298

def variant
  @variant
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


4305
4306
4307
4308
4309
4310
4311
# File 'generated/google/apis/games_v1/classes.rb', line 4305

def update!(**args)
  @auto_matching_criteria = args[:auto_matching_criteria] if args.key?(:auto_matching_criteria)
  @invited_player_ids = args[:invited_player_ids] if args.key?(:invited_player_ids)
  @kind = args[:kind] if args.key?(:kind)
  @request_id = args[:request_id] if args.key?(:request_id)
  @variant = args[:variant] if args.key?(:variant)
end