GoogleApi.Chat.V1.Api.Dms (google_api_chat v0.26.0) View Source

API calls for all endpoints tagged Dms.

Link to this section Summary

Functions

Legacy path for creating message. Calling these will result in a BadRequest response.

Legacy path for creating message. Calling these will result in a BadRequest response.

Legacy path for creating message. Calling these will result in a BadRequest response.

Link to this section Functions

Link to this function

chat_dms_conversations_messages(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

chat_dms_conversations_messages(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Chat.V1.Model.Message.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Legacy path for creating message. Calling these will result in a BadRequest response.

Parameters

  • connection (type: GoogleApi.Chat.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Space resource name, in the form "spaces/*". Example: spaces/AAAAMpdlehY
  • 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").
    • :threadKey (type: 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 (type: GoogleApi.Chat.V1.Model.Message.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Chat.V1.Model.Message{}} on success
  • {:error, info} on failure
Link to this function

chat_dms_messages(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

chat_dms_messages(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Chat.V1.Model.Message.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Legacy path for creating message. Calling these will result in a BadRequest response.

Parameters

  • connection (type: GoogleApi.Chat.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Space resource name, in the form "spaces/*". Example: spaces/AAAAMpdlehY
  • 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").
    • :threadKey (type: 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 (type: GoogleApi.Chat.V1.Model.Message.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Chat.V1.Model.Message{}} on success
  • {:error, info} on failure
Link to this function

chat_dms_webhooks(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

chat_dms_webhooks(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Chat.V1.Model.Message.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Legacy path for creating message. Calling these will result in a BadRequest response.

Parameters

  • connection (type: GoogleApi.Chat.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Space resource name, in the form "spaces/*". Example: spaces/AAAAMpdlehY
  • 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").
    • :threadKey (type: 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 (type: GoogleApi.Chat.V1.Model.Message.t) -
  • opts (type: keyword()) - Call options

Returns

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