Class: Google::Apis::GamesV1::TurnBasedMatch

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

Returns a new instance of TurnBasedMatch.



3953
3954
3955
 
# File 'generated/google/apis/games_v1/classes.rb', line 3953

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) 


3828
3829
3830
 
# File 'generated/google/apis/games_v1/classes.rb', line 3828

def application_id
  @application_id
end

#auto_matching_criteria ⇒ Google::Apis::GamesV1::TurnBasedAutoMatchingCriteria

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

Returns:



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

def auto_matching_criteria
  @auto_matching_criteria
end

#creation_details ⇒ Google::Apis::GamesV1::TurnBasedMatchModification

This is a JSON template for turn-based match modification metadata. Corresponds to the JSON property creationDetails

Returns:



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

def creation_details
  @creation_details
end

#data ⇒ Google::Apis::GamesV1::TurnBasedMatchData

This is a JSON template for a turn-based match data object. Corresponds to the JSON property data

Returns:



3843
3844
3845
 
# File 'generated/google/apis/games_v1/classes.rb', line 3843

def data
  @data
end

#description ⇒ String

This short description is generated by our servers based on turn state and is localized and worded relative to the player requesting the match. It is intended to be displayed when the match is shown in a list. Corresponds to the JSON property description

Returns:

  • (String) 


3850
3851
3852
 
# File 'generated/google/apis/games_v1/classes.rb', line 3850

def description
  @description
end

#inviter_id ⇒ String

The ID of the participant that invited the user to the match. Not set if the user was not invited to the match. Corresponds to the JSON property inviterId

Returns:

  • (String) 


3856
3857
3858
 
# File 'generated/google/apis/games_v1/classes.rb', line 3856

def inviter_id
  @inviter_id
end

#kind ⇒ String

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

Returns:

  • (String) 


3862
3863
3864
 
# File 'generated/google/apis/games_v1/classes.rb', line 3862

def kind
  @kind
end

#last_update_details ⇒ Google::Apis::GamesV1::TurnBasedMatchModification

This is a JSON template for turn-based match modification metadata. Corresponds to the JSON property lastUpdateDetails

Returns:



3867
3868
3869
 
# File 'generated/google/apis/games_v1/classes.rb', line 3867

def last_update_details
  @last_update_details
end

#match_id ⇒ String

Globally unique ID for a turn-based match. Corresponds to the JSON property matchId

Returns:

  • (String) 


3872
3873
3874
 
# File 'generated/google/apis/games_v1/classes.rb', line 3872

def match_id
  @match_id
end

#match_number ⇒ Fixnum

The number of the match in a chain of rematches. Will be set to 1 for the first match and incremented by 1 for each rematch. Corresponds to the JSON property matchNumber

Returns:

  • (Fixnum) 


3878
3879
3880
 
# File 'generated/google/apis/games_v1/classes.rb', line 3878

def match_number
  @match_number
end

#match_version ⇒ Fixnum

The version of this match: an increasing counter, used to avoid out-of-date updates to the match. Corresponds to the JSON property matchVersion

Returns:

  • (Fixnum) 


3884
3885
3886
 
# File 'generated/google/apis/games_v1/classes.rb', line 3884

def match_version
  @match_version
end

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

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

Returns:



3890
3891
3892
 
# File 'generated/google/apis/games_v1/classes.rb', line 3890

def participants
  @participants
end

#pending_participant_id ⇒ String

The ID of the participant that is taking a turn. Corresponds to the JSON property pendingParticipantId

Returns:

  • (String) 


3895
3896
3897
 
# File 'generated/google/apis/games_v1/classes.rb', line 3895

def pending_participant_id
  @pending_participant_id
end

#previous_match_data ⇒ Google::Apis::GamesV1::TurnBasedMatchData

This is a JSON template for a turn-based match data object. Corresponds to the JSON property previousMatchData

Returns:



3900
3901
3902
 
# File 'generated/google/apis/games_v1/classes.rb', line 3900

def previous_match_data
  @previous_match_data
end

#rematch_id ⇒ String

The ID of a rematch of this match. Only set for completed matches that have been rematched. Corresponds to the JSON property rematchId

Returns:

  • (String) 


3906
3907
3908
 
# File 'generated/google/apis/games_v1/classes.rb', line 3906

def rematch_id
  @rematch_id
end

#results ⇒ Array<Google::Apis::GamesV1::ParticipantResult>

The results reported for this match. Corresponds to the JSON property results

Returns:



3911
3912
3913
 
# File 'generated/google/apis/games_v1/classes.rb', line 3911

def results
  @results
end

#status ⇒ String

The status of the match. Possible values are:

  • "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; the match cannot be established until they are filled.
  • "MATCH_ACTIVE" - The match has started.
  • "MATCH_COMPLETE" - The match has finished.
  • "MATCH_CANCELED" - The match was canceled.
  • "MATCH_EXPIRED" - The match expired due to inactivity.
  • "MATCH_DELETED" - The match should no longer be shown on the client. Returned only for tombstones for matches when sync is called. Corresponds to the JSON property status

Returns:

  • (String) 


3925
3926
3927
 
# File 'generated/google/apis/games_v1/classes.rb', line 3925

def status
  @status
end

#user_match_status ⇒ String

The status of the current user in the match. Derived from the match type, match status, the user's participant status, and the pending participant for the match. Possible values are:

  • "USER_INVITED" - The user has been invited to join the match and has not responded yet.
  • "USER_AWAITING_TURN" - The user is waiting for their turn.
  • "USER_TURN" - The user has an action to take in the match.
  • "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or expired.) Corresponds to the JSON property userMatchStatus

Returns:

  • (String) 


3939
3940
3941
 
# File 'generated/google/apis/games_v1/classes.rb', line 3939

def user_match_status
  @user_match_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) 


3945
3946
3947
 
# File 'generated/google/apis/games_v1/classes.rb', line 3945

def variant
  @variant
end

#with_participant_id ⇒ String

The ID of another participant in the match that can be used when describing the participants the user is playing with. Corresponds to the JSON property withParticipantId

Returns:

  • (String) 


3951
3952
3953
 
# File 'generated/google/apis/games_v1/classes.rb', line 3951

def with_participant_id
  @with_participant_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
 
# File 'generated/google/apis/games_v1/classes.rb', line 3958

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)
  @creation_details = args[:creation_details] if args.key?(:creation_details)
  @data = args[:data] if args.key?(:data)
  @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)
  @match_id = args[:match_id] if args.key?(:match_id)
  @match_number = args[:match_number] if args.key?(:match_number)
  @match_version = args[:match_version] if args.key?(:match_version)
  @participants = args[:participants] if args.key?(:participants)
  @pending_participant_id = args[:pending_participant_id] if args.key?(:pending_participant_id)
  @previous_match_data = args[:previous_match_data] if args.key?(:previous_match_data)
  @rematch_id = args[:rematch_id] if args.key?(:rematch_id)
  @results = args[:results] if args.key?(:results)
  @status = args[:status] if args.key?(:status)
  @user_match_status = args[:user_match_status] if args.key?(:user_match_status)
  @variant = args[:variant] if args.key?(:variant)
  @with_participant_id = args[:with_participant_id] if args.key?(:with_participant_id)
end