Class TurnBasedMatch
This is a JSON template for a turn-based match resource object.
Inheritance
Implements
Namespace: Google.Apis.Games.v1.Data
Assembly: Google.Apis.Games.v1.dll
Syntax
public class TurnBasedMatch : object, IDirectResponseSchemaProperties
ApplicationId
The ID of the application being played.
Declaration
public virtual string ApplicationId { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
AutoMatchingCriteria
Criteria for auto-matching players into this match.
Declaration
public virtual TurnBasedAutoMatchingCriteria AutoMatchingCriteria { get; set; }Property Value
| Type | Description |
|---|---|
| TurnBasedAutoMatchingCriteria |
CreationDetails
Details about the match creation.
Declaration
public virtual TurnBasedMatchModification CreationDetails { get; set; }Property Value
| Type | Description |
|---|---|
| TurnBasedMatchModification |
Data
The data / game state for this match.
Declaration
public virtual TurnBasedMatchData Data { get; set; }Property Value
| Type | Description |
|---|---|
| TurnBasedMatchData |
Description
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.
Declaration
public virtual string Description { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
InviterId
The ID of the participant that invited the user to the match. Not set if the user was not invited to the match.
Declaration
public virtual string InviterId { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Kind
Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatch.
Declaration
public virtual string Kind { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
LastUpdateDetails
Details about the last update to the match.
Declaration
public virtual TurnBasedMatchModification LastUpdateDetails { get; set; }Property Value
| Type | Description |
|---|---|
| TurnBasedMatchModification |
MatchId
Globally unique ID for a turn-based match.
Declaration
public virtual string MatchId { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
MatchNumber
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.
Declaration
public virtual Nullable<int> MatchNumber { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
MatchVersion
The version of this match: an increasing counter, used to avoid out-of-date updates to the match.
Declaration
public virtual Nullable<int> MatchVersion { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
Participants
The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations.
Declaration
public virtual IList<TurnBasedMatchParticipant> Participants { get; set; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<TurnBasedMatchParticipant> |
PendingParticipantId
The ID of the participant that is taking a turn.
Declaration
public virtual string PendingParticipantId { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
PreviousMatchData
The data / game state for the previous match; set for the first turn of rematches only.
Declaration
public virtual TurnBasedMatchData PreviousMatchData { get; set; }Property Value
| Type | Description |
|---|---|
| TurnBasedMatchData |
RematchId
The ID of a rematch of this match. Only set for completed matches that have been rematched.
Declaration
public virtual string RematchId { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Results
The results reported for this match.
Declaration
public virtual IList<ParticipantResult> Results { get; set; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<ParticipantResult> |
Status
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.
Declaration
public virtual string Status { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
UserMatchStatus
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.)
Declaration
public virtual string UserMatchStatus { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Variant
The variant / mode of the application being played; can be any integer value, or left blank.
Declaration
public virtual Nullable<int> Variant { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
WithParticipantId
The ID of another participant in the match that can be used when describing the participants the user is playing with.
Declaration
public virtual string WithParticipantId { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |