class Google::Apis::GamesV1::TurnBasedMatch
This is a JSON template for a turn-based match resource object.
Attributes
The ID of the application being played. Corresponds to the JSON property `applicationId` @return [String]
This is a JSON template for an turn-based auto-match criteria object. Corresponds to the JSON property `autoMatchingCriteria` @return [Google::Apis::GamesV1::TurnBasedAutoMatchingCriteria]
This is a JSON template for turn-based match modification metadata. Corresponds to the JSON property `creationDetails` @return [Google::Apis::GamesV1::TurnBasedMatchModification]
This is a JSON template for a turn-based match data object. Corresponds to the JSON property `data` @return [Google::Apis::GamesV1::TurnBasedMatchData]
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` @return [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` @return [String]
Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatch. Corresponds to the JSON property `kind` @return [String]
This is a JSON template for turn-based match modification metadata. Corresponds to the JSON property `lastUpdateDetails` @return [Google::Apis::GamesV1::TurnBasedMatchModification]
Globally unique ID for a turn-based match. Corresponds to the JSON property `matchId` @return [String]
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` @return [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` @return [Fixnum]
The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations. Corresponds to the JSON property `participants` @return [Array<Google::Apis::GamesV1::TurnBasedMatchParticipant>]
The ID of the participant that is taking a turn. Corresponds to the JSON property `pendingParticipantId` @return [String]
This is a JSON template for a turn-based match data object. Corresponds to the JSON property `previousMatchData` @return [Google::Apis::GamesV1::TurnBasedMatchData]
The ID of a rematch of this match. Only set for completed matches that have been rematched. Corresponds to the JSON property `rematchId` @return [String]
The results reported for this match. Corresponds to the JSON property `results` @return [Array<Google::Apis::GamesV1::ParticipantResult>]
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` @return [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` @return [String]
The variant / mode of the application being played; can be any integer value, or left blank. Corresponds to the JSON property `variant` @return [Fixnum]
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` @return [String]
Public Class Methods
# File generated/google/apis/games_v1/classes.rb, line 4204 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File generated/google/apis/games_v1/classes.rb, line 4209 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