com.google.api.services.games

Class Games.TurnBasedMatches

java.lang.Object

com.google.api.services.games.Games.TurnBasedMatches

Enclosing class:

Games

public class Games.TurnBasedMatches
extends Object

The "turnBasedMatches" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Games.TurnBasedMatches.Cancel
class	Games.TurnBasedMatches.Create
class	Games.TurnBasedMatches.Decline
class	Games.TurnBasedMatches.Dismiss
class	Games.TurnBasedMatches.Finish
class	Games.TurnBasedMatches.Get
class	Games.TurnBasedMatches.Join
class	Games.TurnBasedMatches.Leave
class	Games.TurnBasedMatches.LeaveTurn
class	Games.TurnBasedMatches.List
class	Games.TurnBasedMatches.Rematch
class	Games.TurnBasedMatches.Sync
class	Games.TurnBasedMatches.TakeTurn

Constructor Summary

Constructors

Constructor and Description
Games.TurnBasedMatches()

Method Summary

Methods

Modifier and Type	Method and Description
Games.TurnBasedMatches.Cancel	cancel(String matchId) Cancel a turn-based match.
Games.TurnBasedMatches.Create	create(TurnBasedMatchCreateRequest content) Create a turn-based match.
Games.TurnBasedMatches.Decline	decline(String matchId) Decline an invitation to play a turn-based match.
Games.TurnBasedMatches.Dismiss	dismiss(String matchId) Dismiss a turn-based match from the match list.
Games.TurnBasedMatches.Finish	finish(String matchId, TurnBasedMatchResults content) Finish a turn-based match.
Games.TurnBasedMatches.Get	get(String matchId) Get the data for a turn-based match.
Games.TurnBasedMatches.Join	join(String matchId) Join a turn-based match.
Games.TurnBasedMatches.Leave	leave(String matchId) Leave a turn-based match when it is not the current player's turn, without canceling the match.
Games.TurnBasedMatches.LeaveTurn	leaveTurn(String matchId, Integer matchVersion) Leave a turn-based match during the current player's turn, without canceling the match.
Games.TurnBasedMatches.List	list() Returns turn-based matches the player is or was involved in.
Games.TurnBasedMatches.Rematch	rematch(String matchId) Create a rematch of a match that was previously completed, with the same participants.
Games.TurnBasedMatches.Sync	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.
Games.TurnBasedMatches.TakeTurn	takeTurn(String matchId, TurnBasedMatchTurn content) Commit the results of a player turn.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Games.TurnBasedMatches

public Games.TurnBasedMatches()

Method Detail

cancel

public Games.TurnBasedMatches.Cancel cancel(String matchId)
                                     throws IOException

Cancel a turn-based match. Create a request for the method "turnBasedMatches.cancel". This request holds the parameters needed by the the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

matchId - The ID of the match.

Returns:

the request

Throws:

IOException

create

public Games.TurnBasedMatches.Create create(TurnBasedMatchCreateRequest content)
                                     throws IOException

Create a turn-based match. Create a request for the method "turnBasedMatches.create". This request holds the parameters needed by the the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

content - the TurnBasedMatchCreateRequest

Returns:

the request

Throws:

IOException

decline

public Games.TurnBasedMatches.Decline decline(String matchId)
                                       throws IOException

Decline an invitation to play a turn-based match. Create a request for the method "turnBasedMatches.decline". This request holds the parameters needed by the the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

matchId - The ID of the match.

Returns:

the request

Throws:

IOException

dismiss

public Games.TurnBasedMatches.Dismiss dismiss(String matchId)
                                       throws IOException

Dismiss a turn-based match from the match list. The match will no longer show up in the list and will not generate notifications. Create a request for the method "turnBasedMatches.dismiss". This request holds the parameters needed by the the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

matchId - The ID of the match.

Returns:

the request

Throws:

IOException

finish

public Games.TurnBasedMatches.Finish finish(String matchId,
                                   TurnBasedMatchResults content)
                                     throws IOException

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. Create a request for the method "turnBasedMatches.finish". This request holds the parameters needed by the the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

matchId - The ID of the match.

content - the TurnBasedMatchResults

Returns:

the request

Throws:

IOException

get

public Games.TurnBasedMatches.Get get(String matchId)
                               throws IOException

Get the data for a turn-based match. Create a request for the method "turnBasedMatches.get". This request holds the parameters needed by the the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

matchId - The ID of the match.

Returns:

the request

Throws:

IOException

join

public Games.TurnBasedMatches.Join join(String matchId)
                                 throws IOException

Join a turn-based match. Create a request for the method "turnBasedMatches.join". This request holds the parameters needed by the the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

matchId - The ID of the match.

Returns:

the request

Throws:

IOException

leave

public Games.TurnBasedMatches.Leave leave(String matchId)
                                   throws IOException

Leave a turn-based match when it is not the current player's turn, without canceling the match. Create a request for the method "turnBasedMatches.leave". This request holds the parameters needed by the the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

matchId - The ID of the match.

Returns:

the request

Throws:

IOException

leaveTurn

public Games.TurnBasedMatches.LeaveTurn leaveTurn(String matchId,
                                         Integer matchVersion)
                                           throws IOException

Leave a turn-based match during the current player's turn, without canceling the match. Create a request for the method "turnBasedMatches.leaveTurn". This request holds the parameters needed by the the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

matchId - The ID of the match.

matchVersion - The version of the match being updated.

Returns:

the request

Throws:

IOException

list

public Games.TurnBasedMatches.List list()
                                 throws IOException

Returns turn-based matches the player is or was involved in. Create a request for the method "turnBasedMatches.list". This request holds the parameters needed by the the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Returns:

the request

Throws:

IOException

rematch

public Games.TurnBasedMatches.Rematch rematch(String matchId)
                                       throws IOException

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. Create a request for the method "turnBasedMatches.rematch". This request holds the parameters needed by the the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

matchId - The ID of the match.

Returns:

the request

Throws:

IOException

sync

public Games.TurnBasedMatches.Sync sync()
                                 throws IOException

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. Create a request for the method "turnBasedMatches.sync". This request holds the parameters needed by the the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Returns:

the request

Throws:

IOException

takeTurn

public Games.TurnBasedMatches.TakeTurn takeTurn(String matchId,
                                       TurnBasedMatchTurn content)
                                         throws IOException

Commit the results of a player turn. Create a request for the method "turnBasedMatches.takeTurn". This request holds the parameters needed by the the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

matchId - The ID of the match.

content - the TurnBasedMatchTurn

Returns:

the request

Throws:

IOException