package gapi-ocaml

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
module Visibility : sig ... end
module Projection : sig ... end
module ModifiedDateBehavior : sig ... end
module Corpus : sig ... end
val copy : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?convert:bool -> ?ocr:bool -> ?pinned:bool -> ?visibility:Visibility.t -> ?ocrLanguage:string -> ?timedTextLanguage:string -> ?timedTextTrackName:string -> fileId:string -> GapiDriveV2Model.File.t -> GapiConversation.Session.t -> GapiDriveV2Model.File.t * GapiConversation.Session.t

Creates a copy of the specified file.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter convert

    Whether to convert this file to the corresponding Google Docs format.

  • parameter ocr

    Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.

  • parameter pinned

    Whether to pin the head revision of the new copy. A file can have a maximum of 200 pinned revisions.

  • parameter visibility

    The visibility of the new file. This parameter is only relevant when the source is not a native Google Doc and convert=false.

  • parameter ocrLanguage

    If ocr is true, hints at the language to use. Valid values are BCP 47 codes.

  • parameter timedTextLanguage

    The language of the timed text.

  • parameter timedTextTrackName

    The timed text track name.

  • parameter fileId

    The ID of the file to copy.

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

Permanently deletes a file by ID. Skips the trash. The currently authenticated user must own the file.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter fileId

    The ID of the file to delete.

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/v2/").

  • 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/v2/").

  • 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 -> ?maxResults:int -> ?space:string -> GapiConversation.Session.t -> GapiDriveV2Model.GeneratedIds.t * GapiConversation.Session.t

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

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter maxResults

    Maximum 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 -> ?updateViewedDate:bool -> ?projection:Projection.t -> ?revisionId:string -> fileId:string -> GapiConversation.Session.t -> GapiDriveV2Model.File.t * GapiConversation.Session.t

Gets a file's metadata by ID.

  • parameter base_url

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

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

  • parameter updateViewedDate

    Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.

  • parameter projection

    This parameter is deprecated and has no function.

  • parameter revisionId

    Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.

  • parameter fileId

    The ID for the file in question.

val insert : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?media_source:GapiMediaResource.t -> ?convert:bool -> ?ocr:bool -> ?pinned:bool -> ?useContentAsIndexableText:bool -> ?visibility:Visibility.t -> ?ocrLanguage:string -> ?timedTextLanguage:string -> ?timedTextTrackName:string -> GapiDriveV2Model.File.t -> GapiConversation.Session.t -> GapiDriveV2Model.File.t * GapiConversation.Session.t

Insert a new file.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter convert

    Whether to convert this file to the corresponding Google Docs format.

  • parameter ocr

    Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.

  • parameter pinned

    Whether to pin the head revision of the uploaded file. A file can have a maximum of 200 pinned revisions.

  • parameter useContentAsIndexableText

    Whether to use the content as indexable text.

  • parameter visibility

    The visibility of the new file. This parameter is only relevant when convert=false.

  • parameter ocrLanguage

    If ocr is true, hints at the language to use. Valid values are BCP 47 codes.

  • parameter timedTextLanguage

    The language of the timed text.

  • parameter timedTextTrackName

    The timed text track name.

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

Lists the user's files.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter maxResults

    Maximum number of files to return.

  • parameter corpus

    The body of items (files/documents) to which the query applies.

  • parameter orderBy

    A comma-separated list of sort keys. Valid keys are 'createdDate', 'folder', 'lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', 'quotaBytesUsed', 'recency', 'sharedWithMeDate', 'starred', and 'title'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. 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

    Page token for files.

  • parameter projection

    This parameter is deprecated and has no function.

  • parameter q

    Query string for searching files.

  • parameter spaces

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

val patch : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?convert:bool -> ?newRevision:bool -> ?ocr:bool -> ?pinned:bool -> ?setModifiedDate:bool -> ?updateViewedDate:bool -> ?useContentAsIndexableText:bool -> ?addParents:string -> ?modifiedDateBehavior:ModifiedDateBehavior.t -> ?ocrLanguage:string -> ?removeParents:string -> ?timedTextLanguage:string -> ?timedTextTrackName:string -> fileId:string -> GapiDriveV2Model.File.t -> GapiConversation.Session.t -> GapiDriveV2Model.File.t * GapiConversation.Session.t

Updates file metadata and/or content. This method supports patch semantics.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter convert

    This parameter is deprecated and has no function.

  • parameter newRevision

    Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center.

  • parameter ocr

    Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.

  • parameter pinned

    Whether to pin the new revision. A file can have a maximum of 200 pinned revisions.

  • parameter setModifiedDate

    Whether to set the modified date with the supplied modified date.

  • parameter updateViewedDate

    Whether to update the view date after successfully updating the file.

  • parameter useContentAsIndexableText

    Whether to use the content as indexable text.

  • parameter addParents

    Comma-separated list of parent IDs to add.

  • parameter modifiedDateBehavior

    Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate.

  • parameter ocrLanguage

    If ocr is true, hints at the language to use. Valid values are BCP 47 codes.

  • parameter removeParents

    Comma-separated list of parent IDs to remove.

  • parameter timedTextLanguage

    The language of the timed text.

  • parameter timedTextTrackName

    The timed text track name.

  • parameter fileId

    The ID of the file to update.

val touch : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> fileId:string -> GapiConversation.Session.t -> GapiDriveV2Model.File.t * GapiConversation.Session.t

Set the file's updated time to the current server time.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter fileId

    The ID of the file to update.

val trash : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> fileId:string -> GapiConversation.Session.t -> GapiDriveV2Model.File.t * GapiConversation.Session.t

Moves a file to the trash. The currently authenticated user must own the file.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter fileId

    The ID of the file to trash.

val untrash : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> fileId:string -> GapiConversation.Session.t -> GapiDriveV2Model.File.t * GapiConversation.Session.t

Restores a file from the trash.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter fileId

    The ID of the file to untrash.

val update : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?media_source:GapiMediaResource.t -> ?convert:bool -> ?newRevision:bool -> ?ocr:bool -> ?pinned:bool -> ?setModifiedDate:bool -> ?updateViewedDate:bool -> ?useContentAsIndexableText:bool -> ?addParents:string -> ?modifiedDateBehavior:ModifiedDateBehavior.t -> ?ocrLanguage:string -> ?removeParents:string -> ?timedTextLanguage:string -> ?timedTextTrackName:string -> fileId:string -> GapiDriveV2Model.File.t -> GapiConversation.Session.t -> GapiDriveV2Model.File.t * GapiConversation.Session.t

Updates file metadata and/or content.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter convert

    This parameter is deprecated and has no function.

  • parameter newRevision

    Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center.

  • parameter ocr

    Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.

  • parameter pinned

    Whether to pin the new revision. A file can have a maximum of 200 pinned revisions.

  • parameter setModifiedDate

    Whether to set the modified date with the supplied modified date.

  • parameter updateViewedDate

    Whether to update the view date after successfully updating the file.

  • parameter useContentAsIndexableText

    Whether to use the content as indexable text.

  • parameter addParents

    Comma-separated list of parent IDs to add.

  • parameter modifiedDateBehavior

    Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate.

  • parameter ocrLanguage

    If ocr is true, hints at the language to use. Valid values are BCP 47 codes.

  • parameter removeParents

    Comma-separated list of parent IDs to remove.

  • parameter timedTextLanguage

    The language of the timed text.

  • parameter timedTextTrackName

    The timed text track name.

  • parameter fileId

    The ID of the file to update.

val watch : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?media_download:GapiMediaResource.download -> ?acknowledgeAbuse:bool -> ?updateViewedDate:bool -> ?projection:Projection.t -> ?revisionId:string -> fileId:string -> GapiDriveV2Model.Channel.t -> GapiConversation.Session.t -> GapiDriveV2Model.Channel.t * GapiConversation.Session.t

Subscribe to changes on a file

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter acknowledgeAbuse

    Whether the user is acknowledging the risk of downloading known malware or other abusive files.

  • parameter updateViewedDate

    Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.

  • parameter projection

    This parameter is deprecated and has no function.

  • parameter revisionId

    Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.

  • parameter fileId

    The ID for the file in question.