View Source GoogleApi.Chat.V1.Api.Media (google_api_chat v0.34.3)

API calls for all endpoints tagged Media.

Summary

Functions

chat_media_download(connection, resource_name, optional_params \\ [], opts \\ [])

Downloads media. Download is supported on the URI /v1/media/{+name}?alt=media.

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

Uploads an attachment. For an example, see Upload media as a file attachment. Requires user authentication. You can upload attachments up to 200 MB. Certain file types aren't supported. For details, see File types blocked by Google Chat.

chat_media_upload_iodata(connection, parent, upload_type, metadata, data, optional_params \\ [], opts \\ [])

Uploads an attachment. For an example, see Upload media as a file attachment. Requires user authentication. You can upload attachments up to 200 MB. Certain file types aren't supported. For details, see File types blocked by Google Chat.

chat_media_upload_resumable(connection, parent, upload_type, optional_params \\ [], opts \\ [])

Uploads an attachment. For an example, see Upload media as a file attachment. Requires user authentication. You can upload attachments up to 200 MB. Certain file types aren't supported. For details, see File types blocked by Google Chat.

chat_media_upload_simple(connection, parent, upload_type, metadata, data, optional_params \\ [], opts \\ [])

Uploads an attachment. For an example, see Upload media as a file attachment. Requires user authentication. You can upload attachments up to 200 MB. Certain file types aren't supported. For details, see File types blocked by Google Chat.

Functions

Link to this function

chat_media_download(connection, resource_name, optional_params \\ [], opts \\ [])

View Source 
@spec chat_media_download(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Chat.V1.Model.Media.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Downloads media. Download is supported on the URI /v1/media/{+name}?alt=media.

Parameters

  • connection (type: GoogleApi.Chat.V1.Connection.t) - Connection to server
  • resource_name (type: String.t) - Name of the media that is being downloaded. See ReadRequest.resource_name.
  • 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.Chat.V1.Model.Media{}} on success
  • {:error, info} on failure
Link to this function

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

View Source 
@spec chat_media_upload(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Chat.V1.Model.UploadAttachmentResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Uploads an attachment. For an example, see Upload media as a file attachment. Requires user authentication. You can upload attachments up to 200 MB. Certain file types aren't supported. For details, see File types blocked by Google Chat.

Parameters

  • connection (type: GoogleApi.Chat.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Resource name of the Chat space in which the attachment is uploaded. Format "spaces/{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.Chat.V1.Model.UploadAttachmentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

chat_media_upload_iodata(connection, parent, upload_type, metadata, data, optional_params \\ [], opts \\ [])

View Source 
@spec chat_media_upload_iodata(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  GoogleApi.Chat.V1.Model.UploadAttachmentRequest.t(),
  iodata(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Chat.V1.Model.UploadAttachmentResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Uploads an attachment. For an example, see Upload media as a file attachment. Requires user authentication. You can upload attachments up to 200 MB. Certain file types aren't supported. For details, see File types blocked by Google Chat.

Parameters

  • connection (type: GoogleApi.Chat.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Resource name of the Chat space in which the attachment is uploaded. Format "spaces/{space}".
  • upload_type (type: String.t) - Upload type. Must be "multipart".
  • metadata (type: GoogleApi.Chat.V1.Model.UploadAttachmentRequest.t) - object metadata
  • data (type: iodata) - Content to upload, as a string or iolist
  • 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.Chat.V1.Model.UploadAttachmentResponse{}} on success
  • {:error, info} on failure
Link to this function

chat_media_upload_resumable(connection, parent, upload_type, optional_params \\ [], opts \\ [])

View Source 
@spec chat_media_upload_resumable(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Uploads an attachment. For an example, see Upload media as a file attachment. Requires user authentication. You can upload attachments up to 200 MB. Certain file types aren't supported. For details, see File types blocked by Google Chat.

Parameters

  • connection (type: GoogleApi.Chat.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Resource name of the Chat space in which the attachment is uploaded. Format "spaces/{space}".
  • upload_type (type: String.t) - Upload type. Must be "resumable".
  • 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.Chat.V1.Model.UploadAttachmentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure
Link to this function

chat_media_upload_simple(connection, parent, upload_type, metadata, data, optional_params \\ [], opts \\ [])

View Source 
@spec chat_media_upload_simple(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  GoogleApi.Chat.V1.Model.UploadAttachmentRequest.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Chat.V1.Model.UploadAttachmentResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Uploads an attachment. For an example, see Upload media as a file attachment. Requires user authentication. You can upload attachments up to 200 MB. Certain file types aren't supported. For details, see File types blocked by Google Chat.

Parameters

  • connection (type: GoogleApi.Chat.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Resource name of the Chat space in which the attachment is uploaded. Format "spaces/{space}".
  • upload_type (type: String.t) - Upload type. Must be "multipart".
  • metadata (type: GoogleApi.Chat.V1.Model.UploadAttachmentRequest.t) - object metadata
  • data (type: String.t) - Path to file containing content to upload
  • 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.Chat.V1.Model.UploadAttachmentResponse{}} on success
  • {:error, info} on failure