GoogleApi.Meet.V2.Api.Spaces (google_api_meet v0.4.0)

API calls for all endpoints tagged Spaces.

Summary

Functions

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

Creates a space.

meet_spaces_end_active_conference(connection, name, optional_params \\ [], opts \\ [])

Ends an active conference (if there's one). For an example, see End active conference.

meet_spaces_get(connection, name, optional_params \\ [], opts \\ [])

Gets details about a meeting space. For an example, see Get a meeting space.

meet_spaces_patch(connection, name, optional_params \\ [], opts \\ [])

Updates details about a meeting space. For an example, see Update a meeting space.

Functions

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

@spec meet_spaces_create(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Meet.V2.Model.Space.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a space.

Parameters

connection (type: GoogleApi.Meet.V2.Connection.t) - Connection to server
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Meet.V2.Model.Space.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Meet.V2.Model.Space{}} on success
{:error, info} on failure

meet_spaces_end_active_conference(connection, name, optional_params \\ [], opts \\ [])

@spec meet_spaces_end_active_conference(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Meet.V2.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Ends an active conference (if there's one). For an example, see End active conference.

Parameters

connection (type: GoogleApi.Meet.V2.Connection.t) - Connection to server
name (type: String.t) - Required. Resource name of the space. Format: spaces/{space}. {space} is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, jQCFfuBOdN5z. For more information, see How Meet identifies a meeting space.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.Meet.V2.Model.EndActiveConferenceRequest.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Meet.V2.Model.Empty{}} on success
{:error, info} on failure

meet_spaces_get(connection, name, optional_params \\ [], opts \\ [])

@spec meet_spaces_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Meet.V2.Model.Space.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets details about a meeting space. For an example, see Get a meeting space.

Parameters

connection (type: GoogleApi.Meet.V2.Connection.t) - Connection to server
name (type: String.t) - Required. Resource name of the space. Format: spaces/{space} or spaces/{meetingCode}. {space} is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, jQCFfuBOdN5z. {meetingCode} is an alias for the space. It's a typeable, unique character string and is non-case sensitive. For example, abc-mnop-xyz. The maximum length is 128 characters. A meetingCode shouldn't be stored long term as it can become dissociated from a meeting space and can be reused for different meeting spaces in the future. Generally, a meetingCode expires 365 days after last use. For more information, see Learn about meeting codes in Google Meet. For more information, see How Meet identifies a meeting space.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Meet.V2.Model.Space{}} on success
{:error, info} on failure

meet_spaces_patch(connection, name, optional_params \\ [], opts \\ [])

@spec meet_spaces_patch(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Meet.V2.Model.Space.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates details about a meeting space. For an example, see Update a meeting space.

Parameters

connection (type: GoogleApi.Meet.V2.Connection.t) - Connection to server
name (type: String.t) - Immutable. Resource name of the space. Format: spaces/{space}. {space} is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, jQCFfuBOdN5z. For more information, see How Meet identifies a meeting space.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :updateMask (type: String.t) - Optional. Field mask used to specify the fields to be updated in the space. If update_mask isn't provided(not set, set with empty paths, or only has "" as paths), it defaults to update all fields provided with values in the request. Using "*" as update_mask will update all fields, including deleting fields not set in the request.
- :body (type: GoogleApi.Meet.V2.Model.Space.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Meet.V2.Model.Space{}} on success
{:error, info} on failure