google_api_chat v0.1.0 GoogleApi.Chat.V1.Api.Spaces View Source

API calls for all endpoints tagged Spaces.

Link to this section Summary

Link to this section Functions

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

Lists spaces the caller is a member of.

Parameters

  • connection (GoogleApi.Chat.V1.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :pageToken (String.t): A token identifying a page of results the server should return.
    • :pageSize (integer()): Requested page size. The value is capped at 1000. Server may return fewer results than requested. If unspecified, server will default to 100.

Returns

{:ok, %GoogleApi.Chat.V1.Model.ListSpacesResponse{}} on success {:error, info} on failure

Link to this function chat_spaces_members_list(connection, parent, opts \\ []) View Source
chat_spaces_members_list(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Chat.V1.Model.ListMembershipsResponse.t()}
  | {:error, Tesla.Env.t()}

Lists human memberships in a space.

Parameters

  • connection (GoogleApi.Chat.V1.Connection): Connection to server
  • parent (String.t): Required. The resource name of the space for which membership list is to be fetched, in the form "spaces/*". Example: spaces/AAAAMpdlehY
  • opts (KeywordList): [optional] Optional parameters

    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :pageToken (String.t): A token identifying a page of results the server should return.
    • :pageSize (integer()): Requested page size. The value is capped at 1000. Server may return fewer results than requested. If unspecified, server will default to 100.

Returns

{:ok, %GoogleApi.Chat.V1.Model.ListMembershipsResponse{}} on success {:error, info} on failure

Link to this function chat_spaces_messages_create(connection, parent, opts \\ []) View Source
chat_spaces_messages_create(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Chat.V1.Model.Message.t()} | {:error, Tesla.Env.t()}

Creates a message.

Parameters

  • connection (GoogleApi.Chat.V1.Connection): Connection to server
  • parent (String.t): Required. Space resource name, in the form "spaces/*". Example: spaces/AAAAMpdlehY
  • opts (KeywordList): [optional] Optional parameters

    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :threadKey (String.t): Opaque thread identifier string that can be specified to group messages into a single thread. If this is the first message with a given thread identifier, a new thread is created. Subsequent messages with the same thread identifier will be posted into the same thread. This relieves bots and webhooks from having to store the Hangouts Chat thread ID of a thread (created earlier by them) to post further updates to it. Has no effect if thread field, corresponding to an existing thread, is set in message.
    • :body (Message):

Returns

{:ok, %GoogleApi.Chat.V1.Model.Message{}} on success {:error, info} on failure

Link to this function chat_spaces_messages_delete(connection, name, opts \\ []) View Source
chat_spaces_messages_delete(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Chat.V1.Model.Empty.t()} | {:error, Tesla.Env.t()}

Deletes a message.

Parameters

  • connection (GoogleApi.Chat.V1.Connection): Connection to server
  • name (String.t): Required. Resource name of the message to be deleted, in the form "spaces//messages/" Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
  • opts (KeywordList): [optional] Optional parameters

    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").

Returns

{:ok, %GoogleApi.Chat.V1.Model.Empty{}} on success {:error, info} on failure

Link to this function chat_spaces_messages_get(connection, name, opts \\ []) View Source
chat_spaces_messages_get(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Chat.V1.Model.Message.t()} | {:error, Tesla.Env.t()}

Returns a message.

Parameters

  • connection (GoogleApi.Chat.V1.Connection): Connection to server
  • name (String.t): Required. Resource name of the message to be retrieved, in the form "spaces//messages/". Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
  • opts (KeywordList): [optional] Optional parameters

    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").

Returns

{:ok, %GoogleApi.Chat.V1.Model.Message{}} on success {:error, info} on failure

Link to this function chat_spaces_messages_update(connection, name, opts \\ []) View Source
chat_spaces_messages_update(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Chat.V1.Model.Message.t()} | {:error, Tesla.Env.t()}

Updates a message.

Parameters

  • connection (GoogleApi.Chat.V1.Connection): Connection to server
  • name (String.t): Resource name, in the form "spaces//messages/". Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
  • opts (KeywordList): [optional] Optional parameters

    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :updateMask (String.t): Required. The field paths to be updated. Currently supported field paths: "text", "cards".
    • :body (Message):

Returns

{:ok, %GoogleApi.Chat.V1.Model.Message{}} on success {:error, info} on failure