google_api_drive v0.1.0 GoogleApi.Drive.V3.Api.Changes View Source

API calls for all endpoints tagged Changes.

Link to this section Summary

Functions

Gets the starting pageToken for listing future changes

Lists the changes for a user or Team Drive

Link to this section Functions

Link to this function drive_changes_get_start_page_token(connection, opts \\ []) View Source
drive_changes_get_start_page_token(Tesla.Env.client(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.StartPageToken.t()} | {:error, Tesla.Env.t()}

Gets the starting pageToken for listing future changes.

Parameters

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

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :supportsTeamDrives (boolean()): Whether the requesting application supports Team Drives.
    • :teamDriveId (String.t): The ID of the Team Drive for which the starting pageToken for listing future changes from that Team Drive will be returned.

Returns

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

Link to this function drive_changes_list(connection, page_token, opts \\ []) View Source
drive_changes_list(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.ChangeList.t()} | {:error, Tesla.Env.t()}

Lists the changes for a user or Team Drive.

Parameters

  • connection (GoogleApi.Drive.V3.Connection): Connection to server
  • page_token (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 or to the response from the getStartPageToken method.
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :includeCorpusRemovals (boolean()): Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.
    • :includeRemoved (boolean()): Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.
    • :includeTeamDriveItems (boolean()): Whether Team Drive files or changes should be included in results.
    • :pageSize (integer()): The maximum number of changes to return per page.
    • :restrictToMyDrive (boolean()): Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.
    • :spaces (String.t): A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.
    • :supportsTeamDrives (boolean()): Whether the requesting application supports Team Drives.
    • :teamDriveId (String.t): The Team Drive from which changes will be returned. If specified the change IDs will be reflective of the Team Drive; use the combined Team Drive ID and change ID as an identifier.

Returns

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

Link to this function drive_changes_watch(connection, page_token, opts \\ []) View Source
drive_changes_watch(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.Channel.t()} | {:error, Tesla.Env.t()}

Subscribes to changes for a user.

Parameters

  • connection (GoogleApi.Drive.V3.Connection): Connection to server
  • page_token (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 or to the response from the getStartPageToken method.
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :includeCorpusRemovals (boolean()): Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.
    • :includeRemoved (boolean()): Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.
    • :includeTeamDriveItems (boolean()): Whether Team Drive files or changes should be included in results.
    • :pageSize (integer()): The maximum number of changes to return per page.
    • :restrictToMyDrive (boolean()): Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.
    • :spaces (String.t): A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.
    • :supportsTeamDrives (boolean()): Whether the requesting application supports Team Drives.
    • :teamDriveId (String.t): The Team Drive from which changes will be returned. If specified the change IDs will be reflective of the Team Drive; use the combined Team Drive ID and change ID as an identifier.
    • :resource (Channel):

Returns

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