package gapi-ocaml

  1. Overview
  2. Docs
package gapi-ocaml
Legend:
Library
Module
Module type
Parameter
Class
Class type
val getStartPageToken : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?custom_headers:GapiCore.Header.t list -> ?supportsAllDrives:bool -> ?supportsTeamDrives:bool -> ?driveId:string -> ?teamDriveId:string -> GapiConversation.Session.t -> GapiDriveV3Model.StartPageToken.t * GapiConversation.Session.t

Gets the starting pageToken for listing future changes.

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/drive/v3/").

  • parameter std_params

    Optional standard parameters.

  • parameter custom_headers

    Optional HTTP custom headers.

  • parameter supportsAllDrives

    Whether the requesting application supports both My Drives and shared drives.

  • parameter supportsTeamDrives

    Deprecated use supportsAllDrives instead.

  • parameter driveId

    The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive is returned.

  • parameter teamDriveId

    Deprecated use driveId instead.

val list : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?custom_headers:GapiCore.Header.t list -> ?includeCorpusRemovals:bool -> ?includeItemsFromAllDrives:bool -> ?includeRemoved:bool -> ?includeTeamDriveItems:bool -> ?pageSize:int -> ?restrictToMyDrive:bool -> ?spaces:string -> ?supportsAllDrives:bool -> ?supportsTeamDrives:bool -> ?driveId:string -> ?includePermissionsForView:string -> ?teamDriveId:string -> pageToken:string -> GapiConversation.Session.t -> GapiDriveV3Model.ChangeList.t * GapiConversation.Session.t

Lists the changes for a user or shared drive.

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/drive/v3/").

  • parameter std_params

    Optional standard parameters.

  • parameter custom_headers

    Optional HTTP custom headers.

  • parameter includeCorpusRemovals

    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.

  • parameter includeItemsFromAllDrives

    Whether both My Drive and shared drive items should be included in results.

  • parameter includeRemoved

    Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.

  • parameter includeTeamDriveItems

    Deprecated use includeItemsFromAllDrives instead.

  • parameter pageSize

    The maximum number of changes to return per page.

  • parameter restrictToMyDrive

    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.

  • parameter spaces

    A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.

  • parameter supportsAllDrives

    Whether the requesting application supports both My Drives and shared drives.

  • parameter supportsTeamDrives

    Deprecated use supportsAllDrives instead.

  • parameter driveId

    The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.

  • parameter includePermissionsForView

    Specifies which additional view's permissions to include in the response. Only 'published' is supported.

  • parameter teamDriveId

    Deprecated use driveId instead.

  • parameter pageToken

    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.

val watch : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?custom_headers:GapiCore.Header.t list -> ?includeCorpusRemovals:bool -> ?includeItemsFromAllDrives:bool -> ?includeRemoved:bool -> ?includeTeamDriveItems:bool -> ?pageSize:int -> ?restrictToMyDrive:bool -> ?spaces:string -> ?supportsAllDrives:bool -> ?supportsTeamDrives:bool -> ?driveId:string -> ?includePermissionsForView:string -> ?teamDriveId:string -> pageToken:string -> GapiDriveV3Model.Channel.t -> GapiConversation.Session.t -> GapiDriveV3Model.Channel.t * GapiConversation.Session.t

Subscribes to changes for a user.

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/drive/v3/").

  • parameter std_params

    Optional standard parameters.

  • parameter custom_headers

    Optional HTTP custom headers.

  • parameter includeCorpusRemovals

    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.

  • parameter includeItemsFromAllDrives

    Whether both My Drive and shared drive items should be included in results.

  • parameter includeRemoved

    Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.

  • parameter includeTeamDriveItems

    Deprecated use includeItemsFromAllDrives instead.

  • parameter pageSize

    The maximum number of changes to return per page.

  • parameter restrictToMyDrive

    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.

  • parameter spaces

    A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.

  • parameter supportsAllDrives

    Whether the requesting application supports both My Drives and shared drives.

  • parameter supportsTeamDrives

    Deprecated use supportsAllDrives instead.

  • parameter driveId

    The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.

  • parameter includePermissionsForView

    Specifies which additional view's permissions to include in the response. Only 'published' is supported.

  • parameter teamDriveId

    Deprecated use driveId instead.

  • parameter pageToken

    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.