package gapi-ocaml

  1. Overview
  2. Docs
package gapi-ocaml
Legend:
Library
Module
Module type
Parameter
Class
Class type

Service definition for Google Documents List API (v3).

The Google Documents List API allows client applications to view and manipulate files in a user's Documents List.

For more information about this service, see the API Documentation.

module QueryParameters : sig ... end

Query parameters used by the services.

val feed_scope : string

Documents feed scope.

val docs_scope : string

Documents feed scope.

Scope allowing documents download.

val spreadsheets_scope : string

Scope allowing documents download.

Scope allowing spreadsheets download.

val all_scopes : string

Scope allowing spreadsheets download.

val resumable_upload : ?convert:bool -> ?ocr:bool -> ?ocr_language:string -> ?sourceLanguage:string -> ?targetLanguage:string -> ?new_revision:bool -> string -> GapiMediaResource.t -> GapiConversation.Session.t -> GdataDocumentsV3Model.Document.Entry.t * GapiConversation.Session.t

resumable_upload url source session: Uploads the document specified in source to URL url in session session, using the resumable upload protocol.

val partial_download : ?ranges:(int64 option * int64 option) list -> string -> GapiMediaResource.destination -> GapiConversation.Session.t -> unit * GapiConversation.Session.t

partial_download url dest session: Downloads a resource from URL url to destination dest in session session.

  • parameter ranges

    Specifies a list of ranges (start-end byte ranges). If not provided, the document will be fully downloaded.

val download_content : ?format:string -> ?gid:string -> GdataAtom.Content.t -> GapiMediaResource.destination -> GapiConversation.Session.t -> unit * GapiConversation.Session.t

download_content content dest session: Downloads a document extracting URL from content to destination dest in session session.

val query_metadata : ?url:string -> ?etag:string -> ?parameters:QueryParameters.t -> GapiConversation.Session.t -> GdataDocumentsV3Model.Metadata.Entry.t * GapiConversation.Session.t

Queries the metadata feed for the currently authorized user.

val query_changes : ?url:string -> ?etag:string -> ?parameters:QueryParameters.t -> GapiConversation.Session.t -> GdataDocumentsV3Model.Document.Feed.t * GapiConversation.Session.t

Queries the changes feed for the currently authorized user.

val query_documents_list : ?url:string -> ?etag:string -> ?parameters:QueryParameters.t -> GapiConversation.Session.t -> GdataDocumentsV3Model.Document.Feed.t * GapiConversation.Session.t

Queries the documents feed for the currently authorized user.

Gets the resumable create media link from the documents feed.

Gets a document entry by its resource id.

Reloads a document entry.

Creates a new document on the server.

  • parameter media_source

    Document to upload. If not specified, a new empty document (with metadata only) will be created.

Duplicates a document in a user's Google Docs list.

Updates a document.

  • parameter media_source

    Document to upload, to replace the current one. If not specified, only metadata will be updated.

download_document entry dest session: Downloads the document associated with entry entry to destination dest in session session.

Deletes a document.

Performs batch processing of operations on documents feed.

Queries revisions feed of a document.

Reloads a revision entry.

download_revision entry dest session: Downloads a specific revision (entry) of a document to destination dest in session session.

Updates a revision entry.

Deletes a revision entry.

val root_folder_id : string

Root folder ID, used to query root folder content.

val query_folder_contents : ?base_url:string -> ?etag:string -> ?parameters:QueryParameters.t -> string -> GapiConversation.Session.t -> GdataDocumentsV3Model.Document.Feed.t * GapiConversation.Session.t

query_folder_contents folder_id session: Queries the contents of folder folder_id.

create_subfolder folder_id entry session: Creates the new folder entry in folder folder_id.

add_to_folder folder_id entry session: Adds document entry to folder folder_id.

Gets the ACL for a document.

Reloads the ACL for a document.

Creates a new ACL for a document.

Updates an ACL entry.

Deletes an ACL entry.

Performs batch processing of operations on ACL feed.

The archive feed can be used to export resources as a .zip file. The entry determines the desired export format for each type of resource.

Reloads an archive entry.

Updates an archive entry.

Deletes an archive entry.