google_api_games

v0.3.1

google_api_games v0.3.1 GoogleApi.Games.V1.Api.Rooms View Source

API calls for all endpoints tagged Rooms.

Link to this section Summary

Functions

games_rooms_create(connection, optional_params \\ [], opts \\ [])

Create a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

games_rooms_decline(connection, room_id, optional_params \\ [], opts \\ [])

Decline an invitation to join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

games_rooms_dismiss(connection, room_id, optional_params \\ [], opts \\ [])

Dismiss an invitation to join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

games_rooms_get(connection, room_id, optional_params \\ [], opts \\ [])

Get the data for a room.

games_rooms_join(connection, room_id, optional_params \\ [], opts \\ [])

Join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

games_rooms_leave(connection, room_id, optional_params \\ [], opts \\ [])

Leave a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

games_rooms_list(connection, optional_params \\ [], opts \\ [])

Returns invitations to join rooms.

games_rooms_report_status(connection, room_id, optional_params \\ [], opts \\ [])

Updates sent by a client reporting the status of peers in a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

Link to this section Functions

Link to this function

games_rooms_create(connection, optional_params \\ [], opts \\ []) View Source

Create a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

Parameters

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

  • optional_params (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 (RoomCreateRequest):

Returns

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

Link to this function

games_rooms_decline(connection, room_id, optional_params \\ [], opts \\ []) View Source

Decline an invitation to join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

Parameters

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

  • optional_params (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.Room{}} on success {:error, info} on failure

Link to this function

games_rooms_dismiss(connection, room_id, optional_params \\ [], opts \\ []) View Source

Dismiss an invitation to join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

Parameters

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

  • optional_params (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_rooms_get(connection, room_id, optional_params \\ [], opts \\ []) View Source

Get the data for a room.

Parameters

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

  • optional_params (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.Room{}} on success {:error, info} on failure

Link to this function

games_rooms_join(connection, room_id, optional_params \\ [], opts \\ []) View Source

Join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

Parameters

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

  • optional_params (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 (RoomJoinRequest):

Returns

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

Link to this function

games_rooms_leave(connection, room_id, optional_params \\ [], opts \\ []) View Source

Leave a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

Parameters

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

  • optional_params (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 (RoomLeaveRequest):

Returns

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

Link to this function

games_rooms_list(connection, optional_params \\ [], opts \\ []) View Source

Returns invitations to join rooms.

Parameters

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

  • optional_params (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.
    • :maxResults (integer()): The maximum number of rooms to return in the response, used for paging. For any response, the actual number of rooms 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.RoomList{}} on success {:error, info} on failure

Link to this function

games_rooms_report_status(connection, room_id, optional_params \\ [], opts \\ []) View Source

Updates sent by a client reporting the status of peers in a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

Parameters

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

  • optional_params (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 (RoomP2PStatuses):

Returns

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