google_api_games v0.9.0 GoogleApi.Games.V1.Api.Rooms View Source
API calls for all endpoints tagged Rooms.
Link to this section Summary
Functions
Create a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
Decline an invitation to join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
Dismiss an invitation to join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
Get the data for a room.
Join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
Leave a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
Returns invitations to join rooms.
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 Sourcegames_rooms_create(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.Games.V1.Model.Room.t()} | {:error, Tesla.Env.t()}
Create a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
Parameters
connection(type:GoogleApi.Games.V1.Connection.t) - Connection to serveroptional_params(type:keyword()) - Optional parameters:alt(type:String.t) - Data format for the response.:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type: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(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp(type:String.t) - Deprecated. Please use quotaUser instead.:language(type:String.t) - The preferred language to use for strings returned by this method.:body(type:GoogleApi.Games.V1.Model.RoomCreateRequest.t) -
opts(type:keyword()) - Call options
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 Sourcegames_rooms_decline(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Games.V1.Model.Room.t()} | {:error, Tesla.Env.t()}
Decline an invitation to join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
Parameters
connection(type:GoogleApi.Games.V1.Connection.t) - Connection to serverroom_id(type:String.t) - The ID of the room.optional_params(type:keyword()) - Optional parameters:alt(type:String.t) - Data format for the response.:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type: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(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp(type:String.t) - Deprecated. Please use quotaUser instead.:language(type:String.t) - The preferred language to use for strings returned by this method.
opts(type:keyword()) - Call options
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 Sourcegames_rooms_dismiss(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Dismiss an invitation to join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
Parameters
connection(type:GoogleApi.Games.V1.Connection.t) - Connection to serverroom_id(type:String.t) - The ID of the room.optional_params(type:keyword()) - Optional parameters:alt(type:String.t) - Data format for the response.:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type: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(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp(type:String.t) - Deprecated. Please use quotaUser instead.
opts(type:keyword()) - Call options
Returns
{:ok, %{}}on success{:error, info}on failure
Link to this function
games_rooms_get(connection, room_id, optional_params \\ [], opts \\ [])
View Sourcegames_rooms_get(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Games.V1.Model.Room.t()} | {:error, Tesla.Env.t()}
Get the data for a room.
Parameters
connection(type:GoogleApi.Games.V1.Connection.t) - Connection to serverroom_id(type:String.t) - The ID of the room.optional_params(type:keyword()) - Optional parameters:alt(type:String.t) - Data format for the response.:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type: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(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp(type:String.t) - Deprecated. Please use quotaUser instead.:language(type:String.t) - The preferred language to use for strings returned by this method.
opts(type:keyword()) - Call options
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 Sourcegames_rooms_join(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Games.V1.Model.Room.t()} | {:error, Tesla.Env.t()}
Join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
Parameters
connection(type:GoogleApi.Games.V1.Connection.t) - Connection to serverroom_id(type:String.t) - The ID of the room.optional_params(type:keyword()) - Optional parameters:alt(type:String.t) - Data format for the response.:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type: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(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp(type:String.t) - Deprecated. Please use quotaUser instead.:language(type:String.t) - The preferred language to use for strings returned by this method.:body(type:GoogleApi.Games.V1.Model.RoomJoinRequest.t) -
opts(type:keyword()) - Call options
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 Sourcegames_rooms_leave(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Games.V1.Model.Room.t()} | {:error, Tesla.Env.t()}
Leave a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
Parameters
connection(type:GoogleApi.Games.V1.Connection.t) - Connection to serverroom_id(type:String.t) - The ID of the room.optional_params(type:keyword()) - Optional parameters:alt(type:String.t) - Data format for the response.:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type: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(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp(type:String.t) - Deprecated. Please use quotaUser instead.:language(type:String.t) - The preferred language to use for strings returned by this method.:body(type:GoogleApi.Games.V1.Model.RoomLeaveRequest.t) -
opts(type:keyword()) - Call options
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 Sourcegames_rooms_list(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.Games.V1.Model.RoomList.t()} | {:error, Tesla.Env.t()}
Returns invitations to join rooms.
Parameters
connection(type:GoogleApi.Games.V1.Connection.t) - Connection to serveroptional_params(type:keyword()) - Optional parameters:alt(type:String.t) - Data format for the response.:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type: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(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp(type:String.t) - Deprecated. Please use quotaUser instead.:language(type:String.t) - The preferred language to use for strings returned by this method.:maxResults(type: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(type:String.t) - The token returned by the previous request.
opts(type:keyword()) - Call options
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 Sourcegames_rooms_report_status(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Games.V1.Model.RoomStatus.t()} | {:error, Tesla.Env.t()}
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(type:GoogleApi.Games.V1.Connection.t) - Connection to serverroom_id(type:String.t) - The ID of the room.optional_params(type:keyword()) - Optional parameters:alt(type:String.t) - Data format for the response.:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type: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(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp(type:String.t) - Deprecated. Please use quotaUser instead.:language(type:String.t) - The preferred language to use for strings returned by this method.:body(type:GoogleApi.Games.V1.Model.RoomP2PStatuses.t) -
opts(type:keyword()) - Call options
Returns
{:ok, %GoogleApi.Games.V1.Model.RoomStatus{}}on success{:error, info}on failure