google_api_drive v0.20.4

GoogleApi.Drive.V3.Api.Revisions (google_api_drive v0.20.4) View Source

API calls for all endpoints tagged Revisions.

Link to this section Summary

Functions

drive_revisions_delete(connection, file_id, revision_id, optional_params \\ [], opts \\ [])

Permanently deletes a file version. You can only delete revisions for files with binary content in Google Drive, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted.

drive_revisions_get(connection, file_id, revision_id, optional_params \\ [], opts \\ [])

Gets a revision's metadata or content by ID.

drive_revisions_list(connection, file_id, optional_params \\ [], opts \\ [])

Lists a file's revisions.

drive_revisions_update(connection, file_id, revision_id, optional_params \\ [], opts \\ [])

Updates a revision with patch semantics.

Link to this section Functions

Link to this function

drive_revisions_delete(connection, file_id, revision_id, optional_params \\ [], opts \\ [])

View Source

Specs

drive_revisions_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}

Permanently deletes a file version. You can only delete revisions for files with binary content in Google Drive, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted.

Parameters

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • file_id (type: String.t) - The ID of the file.
  • revision_id (type: String.t) - The ID of the revision.
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • opts (type: keyword()) - Call options

Returns

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

drive_revisions_get(connection, file_id, revision_id, optional_params \\ [], opts \\ [])

View Source

Specs

drive_revisions_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Drive.V3.Model.Revision.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Gets a revision's metadata or content by ID.

Parameters

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • file_id (type: String.t) - The ID of the file.
  • revision_id (type: String.t) - The ID of the revision.
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :acknowledgeAbuse (type: boolean()) - Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Drive.V3.Model.Revision{}} on success
  • {:error, info} on failure
Link to this function

drive_revisions_list(connection, file_id, optional_params \\ [], opts \\ [])

View Source

Specs

drive_revisions_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.RevisionList.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Lists a file's revisions.

Parameters

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • file_id (type: String.t) - The ID of the file.
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :pageSize (type: integer()) - The maximum number of revisions to return per page.
    • :pageToken (type: String.t) - The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Drive.V3.Model.RevisionList{}} on success
  • {:error, info} on failure
Link to this function

drive_revisions_update(connection, file_id, revision_id, optional_params \\ [], opts \\ [])

View Source

Specs

drive_revisions_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Drive.V3.Model.Revision.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Updates a revision with patch semantics.

Parameters

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • file_id (type: String.t) - The ID of the file.
  • revision_id (type: String.t) - The ID of the revision.
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :body (type: GoogleApi.Drive.V3.Model.Revision.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Drive.V3.Model.Revision{}} on success
  • {:error, info} on failure