Class: Google::Apis::GamesV1::TurnBasedMatch
- Inherits:
-
Object
- Object
- Google::Apis::GamesV1::TurnBasedMatch
- 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
-
#application_id ⇒ String
The ID of the application being played.
-
#auto_matching_criteria ⇒ Google::Apis::GamesV1::TurnBasedAutoMatchingCriteria
This is a JSON template for an turn-based auto-match criteria object.
-
#creation_details ⇒ Google::Apis::GamesV1::TurnBasedMatchModification
This is a JSON template for turn-based match modification metadata.
-
#data ⇒ Google::Apis::GamesV1::TurnBasedMatchData
This is a JSON template for a turn-based match data object.
-
#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.
-
#inviter_id ⇒ String
The ID of the participant that invited the user to the match.
-
#kind ⇒ String
Uniquely identifies the type of this resource.
-
#last_update_details ⇒ Google::Apis::GamesV1::TurnBasedMatchModification
This is a JSON template for turn-based match modification metadata.
-
#match_id ⇒ String
Globally unique ID for a turn-based match.
-
#match_number ⇒ Fixnum
The number of the match in a chain of rematches.
-
#match_version ⇒ Fixnum
The version of this match: an increasing counter, used to avoid out-of-date updates to the match.
-
#participants ⇒ Array<Google::Apis::GamesV1::TurnBasedMatchParticipant>
The participants involved in the match, along with their statuses.
-
#pending_participant_id ⇒ String
The ID of the participant that is taking a turn.
-
#previous_match_data ⇒ Google::Apis::GamesV1::TurnBasedMatchData
This is a JSON template for a turn-based match data object.
-
#rematch_id ⇒ String
The ID of a rematch of this match.
-
#results ⇒ Array<Google::Apis::GamesV1::ParticipantResult>
The results reported for this match.
-
#status ⇒ String
The status of the match.
-
#user_match_status ⇒ String
The status of the current user in the match.
-
#variant ⇒ Fixnum
The variant / mode of the application being played; can be any integer value, or left blank.
-
#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.
Instance Method Summary collapse
-
#initialize(**args) ⇒ TurnBasedMatch
constructor
A new instance of TurnBasedMatch.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ TurnBasedMatch
Returns a new instance of TurnBasedMatch.
4238 4239 4240 |
# File 'generated/google/apis/games_v1/classes.rb', line 4238 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
4113 4114 4115 |
# File 'generated/google/apis/games_v1/classes.rb', line 4113 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
4118 4119 4120 |
# File 'generated/google/apis/games_v1/classes.rb', line 4118 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
4123 4124 4125 |
# File 'generated/google/apis/games_v1/classes.rb', line 4123 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
4128 4129 4130 |
# File 'generated/google/apis/games_v1/classes.rb', line 4128 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
4135 4136 4137 |
# File 'generated/google/apis/games_v1/classes.rb', line 4135 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
4141 4142 4143 |
# File 'generated/google/apis/games_v1/classes.rb', line 4141 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
4147 4148 4149 |
# File 'generated/google/apis/games_v1/classes.rb', line 4147 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
4152 4153 4154 |
# File 'generated/google/apis/games_v1/classes.rb', line 4152 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
4157 4158 4159 |
# File 'generated/google/apis/games_v1/classes.rb', line 4157 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
4163 4164 4165 |
# File 'generated/google/apis/games_v1/classes.rb', line 4163 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
4169 4170 4171 |
# File 'generated/google/apis/games_v1/classes.rb', line 4169 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
4175 4176 4177 |
# File 'generated/google/apis/games_v1/classes.rb', line 4175 def participants @participants end |
#pending_participant_id ⇒ String
The ID of the participant that is taking a turn.
Corresponds to the JSON property pendingParticipantId
4180 4181 4182 |
# File 'generated/google/apis/games_v1/classes.rb', line 4180 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
4185 4186 4187 |
# File 'generated/google/apis/games_v1/classes.rb', line 4185 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
4191 4192 4193 |
# File 'generated/google/apis/games_v1/classes.rb', line 4191 def rematch_id @rematch_id end |
#results ⇒ Array<Google::Apis::GamesV1::ParticipantResult>
The results reported for this match.
Corresponds to the JSON property results
4196 4197 4198 |
# File 'generated/google/apis/games_v1/classes.rb', line 4196 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
4210 4211 4212 |
# File 'generated/google/apis/games_v1/classes.rb', line 4210 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
4224 4225 4226 |
# File 'generated/google/apis/games_v1/classes.rb', line 4224 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
4230 4231 4232 |
# File 'generated/google/apis/games_v1/classes.rb', line 4230 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
4236 4237 4238 |
# File 'generated/google/apis/games_v1/classes.rb', line 4236 def with_participant_id @with_participant_id end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 |
# File 'generated/google/apis/games_v1/classes.rb', line 4243 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 |