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.



3960
3961
3962
# File 'generated/google/apis/games_v1/classes.rb', line 3960

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

Instance Attribute Details

#application_idString

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

Returns:

  • (String)


3835
3836
3837
# File 'generated/google/apis/games_v1/classes.rb', line 3835

def application_id
  @application_id
end

#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



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

def auto_matching_criteria
  @auto_matching_criteria
end

#creation_detailsGoogle::Apis::GamesV1::TurnBasedMatchModification

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



3845
3846
3847
# File 'generated/google/apis/games_v1/classes.rb', line 3845

def creation_details
  @creation_details
end

#dataGoogle::Apis::GamesV1::TurnBasedMatchData

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



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

def data
  @data
end

#descriptionString

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)


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

def description
  @description
end

#inviter_idString

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)


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

def inviter_id
  @inviter_id
end

#kindString

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

Returns:

  • (String)


3869
3870
3871
# File 'generated/google/apis/games_v1/classes.rb', line 3869

def kind
  @kind
end

#last_update_detailsGoogle::Apis::GamesV1::TurnBasedMatchModification

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



3874
3875
3876
# File 'generated/google/apis/games_v1/classes.rb', line 3874

def last_update_details
  @last_update_details
end

#match_idString

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

Returns:

  • (String)


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

def match_id
  @match_id
end

#match_numberFixnum

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)


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

def match_number
  @match_number
end

#match_versionFixnum

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)


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

def match_version
  @match_version
end

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



3897
3898
3899
# File 'generated/google/apis/games_v1/classes.rb', line 3897

def participants
  @participants
end

#pending_participant_idString

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

Returns:

  • (String)


3902
3903
3904
# File 'generated/google/apis/games_v1/classes.rb', line 3902

def pending_participant_id
  @pending_participant_id
end

#previous_match_dataGoogle::Apis::GamesV1::TurnBasedMatchData

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



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

def previous_match_data
  @previous_match_data
end

#rematch_idString

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)


3913
3914
3915
# File 'generated/google/apis/games_v1/classes.rb', line 3913

def rematch_id
  @rematch_id
end

#resultsArray<Google::Apis::GamesV1::ParticipantResult>

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



3918
3919
3920
# File 'generated/google/apis/games_v1/classes.rb', line 3918

def results
  @results
end

#statusString

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)


3932
3933
3934
# File 'generated/google/apis/games_v1/classes.rb', line 3932

def status
  @status
end

#user_match_statusString

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)


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

def user_match_status
  @user_match_status
end

#variantFixnum

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

Returns:

  • (Fixnum)


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

def variant
  @variant
end

#with_participant_idString

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)


3958
3959
3960
# File 'generated/google/apis/games_v1/classes.rb', line 3958

def with_participant_id
  @with_participant_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
# File 'generated/google/apis/games_v1/classes.rb', line 3965

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