package gapi-ocaml

You can search for identifiers within the package.

in-package search v0.2.0

package gapi-ocaml

gapi-ocaml
gapi-ocaml.gdata
- GdataACL
  - Entry
  - Feed
  - Rel
  - RoleWithKey
  - Scope
- GdataACLService
- GdataAtom
  - AtomData
  - Author
  - BasicEntry
  - Category
  - Content
  - Contributor
  - Feed
  - Generator
  - GenericExtensions
  - Link
  - LinkRelation
  - MakeFeed
    
    Entry
    
    Extensions
    
    Link
  - MakePersonConstruct
    
    M
  - MakeTextConstruct
    
    M
  - PersonConstruct
  - Rel
  - Rights
  - Subtitle
  - Summary
  - TextConstruct
  - Title
- GdataBatch
- GdataCalendar
  - Comments
    
    Entry
    
    Feed
  - Entry
  - ExtendedProperty
  - Feed
  - Link
  - OriginalEvent
  - Rel
  - Reminder
  - ResourceProperty
  - WebContent
  - WebContentGadgetPref
  - When
  - Where
  - Who
- GdataCalendarEvent
- GdataCalendarService
  - QueryParameters
- GdataComments
  - Comments
    
    Entry
    
    Feed
  - Make
    
    Entry
    
    Feed
    
    Link
- GdataCore
  - Metadata
- GdataDocumentsV3Model
  - AclFeedLink
  - AdditionalRoleInfo
  - AdditionalRoleSet
  - Archive
    
    Conversion
    
    Entry
  - Document
    
    DocumentFeedExtensions
    
    Entry
    
    Feed
  - DocumentFormat
  - ExportFormat
  - Feature
  - ImportFormat
  - MakeDocumentFormat
    
    M
  - MaxUploadSize
  - Metadata
    
    Entry
  - Rel
  - Revision
    
    Entry
    
    Feed
  - RevisionsFeedLink
- GdataDocumentsV3Service
  - QueryParameters
- GdataExtensions
  - FeedLink
  - LastModifiedBy
  - MakeFeedLink
    
    Feed
  - Rel
- GdataService
- GdataUtils

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.

val get_resumable_create_media_link : 
  GapiConversation.Session.t ->
  string * GapiConversation.Session.t

Gets the resumable create media link from the documents feed.

val get_document : 
  ?base_url:string ->
  string ->
  GapiConversation.Session.t ->
  GdataDocumentsV3Model.Document.Entry.t * GapiConversation.Session.t

Gets a document entry by its resource id.

val refresh_document : 
  GdataDocumentsV3Model.Document.Entry.t ->
  GapiConversation.Session.t ->
  GdataDocumentsV3Model.Document.Entry.t * GapiConversation.Session.t

Reloads a document entry.

val create_document : 
  ?url:string ->
  ?parameters:QueryParameters.t ->
  ?media_source:GapiMediaResource.t ->
  GdataDocumentsV3Model.Document.Entry.t ->
  GapiConversation.Session.t ->
  GdataDocumentsV3Model.Document.Entry.t * GapiConversation.Session.t

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.

val copy_document : 
  ?url:string ->
  GdataDocumentsV3Model.Document.Entry.t ->
  GapiConversation.Session.t ->
  GdataDocumentsV3Model.Document.Entry.t * GapiConversation.Session.t

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

val update_document : 
  ?new_revision:bool ->
  ?media_source:GapiMediaResource.t ->
  GdataDocumentsV3Model.Document.Entry.t ->
  GapiConversation.Session.t ->
  GdataDocumentsV3Model.Document.Entry.t * GapiConversation.Session.t

Updates a document.

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

val download_document : 
  ?format:string ->
  ?gid:string ->
  GdataDocumentsV3Model.Document.Entry.t ->
  GapiMediaResource.destination ->
  GapiConversation.Session.t ->
  unit * GapiConversation.Session.t

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

val delete_document : 
  ?delete:bool ->
  GdataDocumentsV3Model.Document.Entry.t ->
  GapiConversation.Session.t ->
  unit * GapiConversation.Session.t

Deletes a document.

val documents_batch_request : 
  ?url:string ->
  GdataDocumentsV3Model.Document.Feed.t ->
  GapiConversation.Session.t ->
  GdataDocumentsV3Model.Document.Feed.t * GapiConversation.Session.t

Performs batch processing of operations on documents feed.

val query_revisions : 
  ?etag:string ->
  ?parameters:QueryParameters.t ->
  GdataDocumentsV3Model.Document.Entry.t ->
  GapiConversation.Session.t ->
  GdataDocumentsV3Model.Revision.Feed.t * GapiConversation.Session.t

Queries revisions feed of a document.

val refresh_revision : 
  GdataDocumentsV3Model.Revision.Entry.t ->
  GapiConversation.Session.t ->
  GdataDocumentsV3Model.Revision.Entry.t * GapiConversation.Session.t

Reloads a revision entry.

val download_revision : 
  ?format:string ->
  ?gid:string ->
  GdataDocumentsV3Model.Revision.Entry.t ->
  GapiMediaResource.destination ->
  GapiConversation.Session.t ->
  unit * GapiConversation.Session.t

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

val update_revision : 
  GdataDocumentsV3Model.Revision.Entry.t ->
  GapiConversation.Session.t ->
  GdataDocumentsV3Model.Revision.Entry.t * GapiConversation.Session.t

Updates a revision entry.

val delete_revision : 
  GdataDocumentsV3Model.Revision.Entry.t ->
  GapiConversation.Session.t ->
  unit * GapiConversation.Session.t

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.

val create_subfolder : 
  ?base_url:string ->
  ?etag:'a ->
  string ->
  GdataDocumentsV3Model.Document.Entry.t ->
  GapiConversation.Session.t ->
  GdataDocumentsV3Model.Document.Entry.t * GapiConversation.Session.t

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

val add_to_folder : 
  ?base_url:string ->
  ?etag:'a ->
  string ->
  GdataDocumentsV3Model.Document.Entry.t ->
  GapiConversation.Session.t ->
  GdataDocumentsV3Model.Document.Entry.t * GapiConversation.Session.t

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

val get_acl : 
  ?etag:string ->
  GdataDocumentsV3Model.Document.Entry.t ->
  GapiConversation.Session.t ->
  GdataACL.Feed.t * GapiConversation.Session.t

Gets the ACL for a document.

val refresh_acl : 
  GdataACL.Entry.t ->
  GapiConversation.Session.t ->
  GdataACL.Entry.t * GapiConversation.Session.t

Reloads the ACL for a document.

val create_acl : 
  ?send_notification_emails:bool ->
  GdataACL.Entry.t ->
  GdataDocumentsV3Model.Document.Entry.t ->
  GapiConversation.Session.t ->
  GdataACL.Entry.t * GapiConversation.Session.t

Creates a new ACL for a document.

val update_acl : 
  GdataACL.Entry.t ->
  GapiConversation.Session.t ->
  GdataACL.Entry.t * GapiConversation.Session.t

Updates an ACL entry.

val delete_acl : 
  GdataACL.Entry.t ->
  GapiConversation.Session.t ->
  unit * GapiConversation.Session.t

Deletes an ACL entry.

val acl_batch_request : 
  GdataACL.Feed.t ->
  GdataACL.Feed.t ->
  GapiConversation.Session.t ->
  GdataACL.Feed.t * GapiConversation.Session.t

Performs batch processing of operations on ACL feed.

val create_archive : 
  ?url:string ->
  ?parameters:QueryParameters.t ->
  GdataDocumentsV3Model.Archive.Entry.t ->
  GapiConversation.Session.t ->
  GdataDocumentsV3Model.Archive.Entry.t * GapiConversation.Session.t

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.

val refresh_archive : 
  GdataDocumentsV3Model.Archive.Entry.t ->
  GapiConversation.Session.t ->
  GdataDocumentsV3Model.Archive.Entry.t * GapiConversation.Session.t

Reloads an archive entry.

val update_archive : 
  GdataDocumentsV3Model.Archive.Entry.t ->
  GapiConversation.Session.t ->
  GdataDocumentsV3Model.Archive.Entry.t * GapiConversation.Session.t

Updates an archive entry.

val delete_archive : 
  GdataDocumentsV3Model.Archive.Entry.t ->
  GapiConversation.Session.t ->
  unit * GapiConversation.Session.t

Deletes an archive entry.