View Source GoogleApi.Keep.V1.Api.Media (google_api_keep v0.3.0)
API calls for all endpoints tagged Media
.
Summary
Functions
Gets an attachment. To download attachment media via REST requires the alt=media query parameter. Returns a 400 bad request error if attachment media is not available in the requested MIME type.
Functions
Link to this function
keep_media_download(connection, name, optional_params \\ [], opts \\ [])
View Source@spec keep_media_download(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Keep.V1.Model.Attachment.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets an attachment. To download attachment media via REST requires the alt=media query parameter. Returns a 400 bad request error if attachment media is not available in the requested MIME type.
Parameters
-
connection
(type:GoogleApi.Keep.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the attachment. -
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"). -
:mimeType
(type:String.t
) - The IANA MIME type format requested. The requested MIME type must be one specified in the attachment.mime_type. Required when downloading attachment media and ignored otherwise.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Keep.V1.Model.Attachment{}}
on success -
{:error, info}
on failure