package gapi-ocaml

  1. Overview
  2. Docs
package gapi-ocaml
Legend:
Library
Module
Module type
Parameter
Class
Class type
module Corpus : sig ... end
val copy : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?ignoreDefaultVisibility:bool -> ?keepRevisionForever:bool -> ?ocrLanguage:string -> fileId:string -> GapiDriveV3Model.File.t -> GapiConversation.Session.t -> GapiDriveV3Model.File.t * GapiConversation.Session.t

Creates a copy of a file and applies any requested updates with patch semantics.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter ignoreDefaultVisibility

    Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.

  • parameter keepRevisionForever

    Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Drive.

  • parameter ocrLanguage

    A language hint for OCR processing during image import (ISO 639-1 code).

  • parameter fileId

    The ID of the file.

val create : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?media_source:GapiMediaResource.t -> ?ignoreDefaultVisibility:bool -> ?keepRevisionForever:bool -> ?useContentAsIndexableText:bool -> ?ocrLanguage:string -> GapiDriveV3Model.File.t -> GapiConversation.Session.t -> GapiDriveV3Model.File.t * GapiConversation.Session.t

Creates a new file.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter ignoreDefaultVisibility

    Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.

  • parameter keepRevisionForever

    Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Drive.

  • parameter useContentAsIndexableText

    Whether to use the uploaded content as indexable text.

  • parameter ocrLanguage

    A language hint for OCR processing during image import (ISO 639-1 code).

val delete : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> fileId:string -> GapiConversation.Session.t -> unit * GapiConversation.Session.t

Permanently deletes a file owned by the user without moving it to the trash. If the target is a folder, all descendants owned by the user are also deleted.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter fileId

    The ID of the file.

val emptyTrash : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> GapiConversation.Session.t -> unit * GapiConversation.Session.t

Permanently deletes all of the user's trashed files.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

val export : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?media_download:GapiMediaResource.download -> fileId:string -> mimeType:string -> GapiConversation.Session.t -> unit * GapiConversation.Session.t

Exports a Google Doc to the requested MIME type and returns the exported content.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter fileId

    The ID of the file.

  • parameter mimeType

    The MIME type of the format requested for this export.

val generateIds : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?count:int -> ?space:string -> GapiConversation.Session.t -> GapiDriveV3Model.GeneratedIds.t * GapiConversation.Session.t

Generates a set of file IDs which can be provided in create requests.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter count

    The number of IDs to return.

  • parameter space

    The space in which the IDs can be used to create new files. Supported values are 'drive' and 'appDataFolder'.

val get : ?base_url:string -> ?etag:string -> ?std_params:GapiService.StandardParameters.t -> ?media_download:GapiMediaResource.download -> ?acknowledgeAbuse:bool -> fileId:string -> GapiConversation.Session.t -> GapiDriveV3Model.File.t * GapiConversation.Session.t

Gets a file's metadata or content by ID.

  • parameter base_url

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

  • parameter etag

    Optional ETag.

  • parameter std_params

    Optional standard parameters.

  • parameter acknowledgeAbuse

    Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.

  • parameter fileId

    The ID of the file.

val list : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?corpus:Corpus.t -> ?pageSize:int -> ?spaces:string -> ?orderBy:string -> ?pageToken:string -> ?q:string -> GapiConversation.Session.t -> GapiDriveV3Model.FileList.t * GapiConversation.Session.t

Lists or searches files.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter corpus

    The source of files to list.

  • parameter pageSize

    The maximum number of files to return per page.

  • parameter spaces

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

  • parameter orderBy

    A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedTime desc,name. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.

  • 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.

  • parameter q

    A query for filtering the file results. See the "Search for Files" guide for supported syntax.

val update : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?media_source:GapiMediaResource.t -> ?keepRevisionForever:bool -> ?useContentAsIndexableText:bool -> ?addParents:string -> ?ocrLanguage:string -> ?removeParents:string -> fileId:string -> GapiDriveV3Model.File.t -> GapiConversation.Session.t -> GapiDriveV3Model.File.t * GapiConversation.Session.t

Updates a file's metadata and/or content with patch semantics.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter keepRevisionForever

    Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Drive.

  • parameter useContentAsIndexableText

    Whether to use the uploaded content as indexable text.

  • parameter addParents

    A comma-separated list of parent IDs to add.

  • parameter ocrLanguage

    A language hint for OCR processing during image import (ISO 639-1 code).

  • parameter removeParents

    A comma-separated list of parent IDs to remove.

  • parameter fileId

    The ID of the file.

val watch : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?media_download:GapiMediaResource.download -> ?acknowledgeAbuse:bool -> fileId:string -> GapiDriveV3Model.Channel.t -> GapiConversation.Session.t -> GapiDriveV3Model.Channel.t * GapiConversation.Session.t

Subscribes to changes to a file

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter acknowledgeAbuse

    Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.

  • parameter fileId

    The ID of the file.