google_api_games

v0.1.0

google_api_games v0.1.0 GoogleApi.Games.V1.Api.TurnBasedMatches View Source

API calls for all endpoints tagged TurnBasedMatches.

Link to this section Summary

Functions

games_turn_based_matches_cancel(connection, match_id, opts \\ [])

Cancel a turn-based match

games_turn_based_matches_create(connection, opts \\ [])

Create a turn-based match

games_turn_based_matches_decline(connection, match_id, opts \\ [])

Decline an invitation to play a turn-based match

games_turn_based_matches_dismiss(connection, match_id, opts \\ [])

Dismiss a turn-based match from the match list. The match will no longer show up in the list and will not generate notifications

games_turn_based_matches_finish(connection, match_id, opts \\ [])

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

games_turn_based_matches_get(connection, match_id, opts \\ [])

Get the data for a turn-based match

games_turn_based_matches_join(connection, match_id, opts \\ [])

Join a turn-based match

games_turn_based_matches_leave(connection, match_id, opts \\ [])

Leave a turn-based match when it is not the current player's turn, without canceling the match

games_turn_based_matches_leave_turn(connection, match_id, match_version, opts \\ [])

Leave a turn-based match during the current player's turn, without canceling the match

games_turn_based_matches_list(connection, opts \\ [])

Returns turn-based matches the player is or was involved in

games_turn_based_matches_rematch(connection, match_id, opts \\ [])

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

games_turn_based_matches_sync(connection, opts \\ [])

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

games_turn_based_matches_take_turn(connection, match_id, opts \\ [])

Commit the results of a player turn

Link to this section Functions

Link to this function games_turn_based_matches_cancel(connection, match_id, opts \\ []) View Source 
games_turn_based_matches_cancel(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Cancel a turn-based match.

Parameters

  • connection (GoogleApi.Games.V1.Connection): Connection to server
  • match_id (String.t): The ID of the match.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function games_turn_based_matches_create(connection, opts \\ []) View Source 
games_turn_based_matches_create(Tesla.Env.client(), keyword()) ::
  {:ok, GoogleApi.Games.V1.Model.TurnBasedMatch.t()} | {:error, Tesla.Env.t()}

Create a turn-based match.

Parameters

  • connection (GoogleApi.Games.V1.Connection): Connection to server

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :language (String.t): The preferred language to use for strings returned by this method.
    • :body (TurnBasedMatchCreateRequest):

Returns

{:ok, %GoogleApi.Games.V1.Model.TurnBasedMatch{}} on success {:error, info} on failure

Link to this function games_turn_based_matches_decline(connection, match_id, opts \\ []) View Source 
games_turn_based_matches_decline(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Games.V1.Model.TurnBasedMatch.t()} | {:error, Tesla.Env.t()}

Decline an invitation to play a turn-based match.

Parameters

  • connection (GoogleApi.Games.V1.Connection): Connection to server
  • match_id (String.t): The ID of the match.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :language (String.t): The preferred language to use for strings returned by this method.

Returns

{:ok, %GoogleApi.Games.V1.Model.TurnBasedMatch{}} on success {:error, info} on failure

Link to this function games_turn_based_matches_dismiss(connection, match_id, opts \\ []) View Source 
games_turn_based_matches_dismiss(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Dismiss a turn-based match from the match list. The match will no longer show up in the list and will not generate notifications.

Parameters

  • connection (GoogleApi.Games.V1.Connection): Connection to server
  • match_id (String.t): The ID of the match.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function games_turn_based_matches_finish(connection, match_id, opts \\ []) View Source 
games_turn_based_matches_finish(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Games.V1.Model.TurnBasedMatch.t()} | {:error, Tesla.Env.t()}

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.

Parameters

  • connection (GoogleApi.Games.V1.Connection): Connection to server
  • match_id (String.t): The ID of the match.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :language (String.t): The preferred language to use for strings returned by this method.
    • :body (TurnBasedMatchResults):

Returns

{:ok, %GoogleApi.Games.V1.Model.TurnBasedMatch{}} on success {:error, info} on failure

Link to this function games_turn_based_matches_get(connection, match_id, opts \\ []) View Source 
games_turn_based_matches_get(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Games.V1.Model.TurnBasedMatch.t()} | {:error, Tesla.Env.t()}

Get the data for a turn-based match.

Parameters

  • connection (GoogleApi.Games.V1.Connection): Connection to server
  • match_id (String.t): The ID of the match.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :includeMatchData (boolean()): Get match data along with metadata.
    • :language (String.t): The preferred language to use for strings returned by this method.

Returns

{:ok, %GoogleApi.Games.V1.Model.TurnBasedMatch{}} on success {:error, info} on failure

Link to this function games_turn_based_matches_join(connection, match_id, opts \\ []) View Source 
games_turn_based_matches_join(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Games.V1.Model.TurnBasedMatch.t()} | {:error, Tesla.Env.t()}

Join a turn-based match.

Parameters

  • connection (GoogleApi.Games.V1.Connection): Connection to server
  • match_id (String.t): The ID of the match.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :language (String.t): The preferred language to use for strings returned by this method.

Returns

{:ok, %GoogleApi.Games.V1.Model.TurnBasedMatch{}} on success {:error, info} on failure

Link to this function games_turn_based_matches_leave(connection, match_id, opts \\ []) View Source 
games_turn_based_matches_leave(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Games.V1.Model.TurnBasedMatch.t()} | {:error, Tesla.Env.t()}

Leave a turn-based match when it is not the current player's turn, without canceling the match.

Parameters

  • connection (GoogleApi.Games.V1.Connection): Connection to server
  • match_id (String.t): The ID of the match.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :language (String.t): The preferred language to use for strings returned by this method.

Returns

{:ok, %GoogleApi.Games.V1.Model.TurnBasedMatch{}} on success {:error, info} on failure

Link to this function games_turn_based_matches_leave_turn(connection, match_id, match_version, opts \\ []) View Source 
games_turn_based_matches_leave_turn(
  Tesla.Env.client(),
  String.t(),
  integer(),
  keyword()
) ::
  {:ok, GoogleApi.Games.V1.Model.TurnBasedMatch.t()} | {:error, Tesla.Env.t()}

Leave a turn-based match during the current player's turn, without canceling the match.

Parameters

  • connection (GoogleApi.Games.V1.Connection): Connection to server
  • match_id (String.t): The ID of the match.
  • match_version (integer()): The version of the match being updated.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :language (String.t): The preferred language to use for strings returned by this method.
    • :pendingParticipantId (String.t): The ID of another participant who should take their turn next. If not set, the match will wait for other player(s) to join via automatching; this is only valid if automatch criteria is set on the match with remaining slots for automatched players.

Returns

{:ok, %GoogleApi.Games.V1.Model.TurnBasedMatch{}} on success {:error, info} on failure

Link to this function games_turn_based_matches_list(connection, opts \\ []) View Source 
games_turn_based_matches_list(Tesla.Env.client(), keyword()) ::
  {:ok, GoogleApi.Games.V1.Model.TurnBasedMatchList.t()}
  | {:error, Tesla.Env.t()}

Returns turn-based matches the player is or was involved in.

Parameters

  • connection (GoogleApi.Games.V1.Connection): Connection to server

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :includeMatchData (boolean()): True if match data should be returned in the response. Note that not all data will necessarily be returned if include_match_data is true; the server may decide to only return data for some of the matches to limit download size for the client. The remainder of the data for these matches will be retrievable on request.
    • :language (String.t): The preferred language to use for strings returned by this method.
    • :maxCompletedMatches (integer()): The maximum number of completed or canceled matches to return in the response. If not set, all matches returned could be completed or canceled.
    • :maxResults (integer()): The maximum number of matches to return in the response, used for paging. For any response, the actual number of matches to return may be less than the specified maxResults.
    • :pageToken (String.t): The token returned by the previous request.

Returns

{:ok, %GoogleApi.Games.V1.Model.TurnBasedMatchList{}} on success {:error, info} on failure

Link to this function games_turn_based_matches_rematch(connection, match_id, opts \\ []) View Source 
games_turn_based_matches_rematch(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Games.V1.Model.TurnBasedMatchRematch.t()}
  | {:error, Tesla.Env.t()}

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.

Parameters

  • connection (GoogleApi.Games.V1.Connection): Connection to server
  • match_id (String.t): The ID of the match.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :language (String.t): The preferred language to use for strings returned by this method.
    • :requestId (String.t): A randomly generated numeric ID for each request specified by the caller. This number is used at the server to ensure that the request is handled correctly across retries.

Returns

{:ok, %GoogleApi.Games.V1.Model.TurnBasedMatchRematch{}} on success {:error, info} on failure

Link to this function games_turn_based_matches_sync(connection, opts \\ []) View Source 
games_turn_based_matches_sync(Tesla.Env.client(), keyword()) ::
  {:ok, GoogleApi.Games.V1.Model.TurnBasedMatchSync.t()}
  | {:error, Tesla.Env.t()}

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.

Parameters

  • connection (GoogleApi.Games.V1.Connection): Connection to server

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :includeMatchData (boolean()): True if match data should be returned in the response. Note that not all data will necessarily be returned if include_match_data is true; the server may decide to only return data for some of the matches to limit download size for the client. The remainder of the data for these matches will be retrievable on request.
    • :language (String.t): The preferred language to use for strings returned by this method.
    • :maxCompletedMatches (integer()): The maximum number of completed or canceled matches to return in the response. If not set, all matches returned could be completed or canceled.
    • :maxResults (integer()): The maximum number of matches to return in the response, used for paging. For any response, the actual number of matches to return may be less than the specified maxResults.
    • :pageToken (String.t): The token returned by the previous request.

Returns

{:ok, %GoogleApi.Games.V1.Model.TurnBasedMatchSync{}} on success {:error, info} on failure

Link to this function games_turn_based_matches_take_turn(connection, match_id, opts \\ []) View Source 
games_turn_based_matches_take_turn(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Games.V1.Model.TurnBasedMatch.t()} | {:error, Tesla.Env.t()}

Commit the results of a player turn.

Parameters

  • connection (GoogleApi.Games.V1.Connection): Connection to server
  • match_id (String.t): The ID of the match.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :language (String.t): The preferred language to use for strings returned by this method.
    • :body (TurnBasedMatchTurn):

Returns

{:ok, %GoogleApi.Games.V1.Model.TurnBasedMatch{}} on success {:error, info} on failure