Class TurnBasedMatchesResource
The "turnBasedMatches" collection of methods.
Inheritance
Namespace: Google.Apis.Games.v1
Assembly: Google.Apis.Games.v1.dll
Syntax
public class TurnBasedMatchesResource : objectConstructors
TurnBasedMatchesResource(IClientService)
Constructs a new resource.
Declaration
public TurnBasedMatchesResource(IClientService service)Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service |
Methods
Cancel(String)
Cancel a turn-based match.
Declaration
public virtual TurnBasedMatchesResource.CancelRequest Cancel(string matchId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | matchId | The ID of the match. |
Returns
| Type | Description |
|---|---|
| TurnBasedMatchesResource.CancelRequest |
Create(TurnBasedMatchCreateRequest)
Create a turn-based match.
Declaration
public virtual TurnBasedMatchesResource.CreateRequest Create(TurnBasedMatchCreateRequest body)Parameters
| Type | Name | Description |
|---|---|---|
| TurnBasedMatchCreateRequest | body | The body of the request. |
Returns
| Type | Description |
|---|---|
| TurnBasedMatchesResource.CreateRequest |
Decline(String)
Decline an invitation to play a turn-based match.
Declaration
public virtual TurnBasedMatchesResource.DeclineRequest Decline(string matchId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | matchId | The ID of the match. |
Returns
| Type | Description |
|---|---|
| TurnBasedMatchesResource.DeclineRequest |
Dismiss(String)
Dismiss a turn-based match from the match list. The match will no longer show up in the list and will not generate notifications.
Declaration
public virtual TurnBasedMatchesResource.DismissRequest Dismiss(string matchId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | matchId | The ID of the match. |
Returns
| Type | Description |
|---|---|
| TurnBasedMatchesResource.DismissRequest |
Finish(TurnBasedMatchResults, String)
Finish a turn-based match. Each player should make this call once, after all results are in. Only the player whose turn it is may make the first call to Finish, and can pass in the final match state.
Declaration
public virtual TurnBasedMatchesResource.FinishRequest Finish(TurnBasedMatchResults body, string matchId)Parameters
| Type | Name | Description |
|---|---|---|
| TurnBasedMatchResults | body | The body of the request. |
| System.String | matchId | The ID of the match. |
Returns
| Type | Description |
|---|---|
| TurnBasedMatchesResource.FinishRequest |
Get(String)
Get the data for a turn-based match.
Declaration
public virtual TurnBasedMatchesResource.GetRequest Get(string matchId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | matchId | The ID of the match. |
Returns
| Type | Description |
|---|---|
| TurnBasedMatchesResource.GetRequest |
Join(String)
Join a turn-based match.
Declaration
public virtual TurnBasedMatchesResource.JoinRequest Join(string matchId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | matchId | The ID of the match. |
Returns
| Type | Description |
|---|---|
| TurnBasedMatchesResource.JoinRequest |
Leave(String)
Leave a turn-based match when it is not the current player's turn, without canceling the match.
Declaration
public virtual TurnBasedMatchesResource.LeaveRequest Leave(string matchId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | matchId | The ID of the match. |
Returns
| Type | Description |
|---|---|
| TurnBasedMatchesResource.LeaveRequest |
LeaveTurn(String, Int32)
Leave a turn-based match during the current player's turn, without canceling the match.
Declaration
public virtual TurnBasedMatchesResource.LeaveTurnRequest LeaveTurn(string matchId, int matchVersion)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | matchId | The ID of the match. |
| System.Int32 | matchVersion | The version of the match being updated. |
Returns
| Type | Description |
|---|---|
| TurnBasedMatchesResource.LeaveTurnRequest |
List()
Returns turn-based matches the player is or was involved in.
Declaration
public virtual TurnBasedMatchesResource.ListRequest List()Returns
| Type | Description |
|---|---|
| TurnBasedMatchesResource.ListRequest |
Rematch(String)
Create a rematch of a match that was previously completed, with the same participants. This can be called by only one player on a match still in their list; the player must have called Finish first. Returns the newly created match; it will be the caller's turn.
Declaration
public virtual TurnBasedMatchesResource.RematchRequest Rematch(string matchId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | matchId | The ID of the match. |
Returns
| Type | Description |
|---|---|
| TurnBasedMatchesResource.RematchRequest |
Sync()
Returns turn-based matches the player is or was involved in that changed since the last sync call, with the least recent changes coming first. Matches that should be removed from the local cache will have a status of MATCH_DELETED.
Declaration
public virtual TurnBasedMatchesResource.SyncRequest Sync()Returns
| Type | Description |
|---|---|
| TurnBasedMatchesResource.SyncRequest |
TakeTurn(TurnBasedMatchTurn, String)
Commit the results of a player turn.
Declaration
public virtual TurnBasedMatchesResource.TakeTurnRequest TakeTurn(TurnBasedMatchTurn body, string matchId)Parameters
| Type | Name | Description |
|---|---|---|
| TurnBasedMatchTurn | body | The body of the request. |
| System.String | matchId | The ID of the match. |
Returns
| Type | Description |
|---|---|
| TurnBasedMatchesResource.TakeTurnRequest |