package gapi-ocaml

  1. Overview
  2. Docs
package gapi-ocaml
Legend:
Library
Module
Module type
Parameter
Class
Class type
val delete : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> fileId:string -> commentId:string -> GapiConversation.Session.t -> unit * GapiConversation.Session.t

Deletes a comment.

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

    The ID of the comment.

val get : ?base_url:string -> ?etag:string -> ?std_params:GapiService.StandardParameters.t -> ?includeDeleted:bool -> fileId:string -> commentId:string -> GapiConversation.Session.t -> GapiDriveV2Model.Comment.t * GapiConversation.Session.t

Gets a comment 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 includeDeleted

    If set, this will succeed when retrieving a deleted comment, and will include any deleted replies.

  • parameter fileId

    The ID of the file.

  • parameter commentId

    The ID of the comment.

Creates a new comment on the given 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.

val list : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?includeDeleted:bool -> ?maxResults:int -> ?pageToken:string -> ?updatedMin:string -> fileId:string -> GapiConversation.Session.t -> GapiDriveV2Model.CommentList.t * GapiConversation.Session.t

Lists a file's comments.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter includeDeleted

    If set, all comments and replies, including deleted comments and replies (with content stripped) will be returned.

  • parameter maxResults

    The maximum number of discussions to include in the response, used for paging.

  • parameter pageToken

    The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.

  • parameter updatedMin

    Only discussions that were updated after this timestamp will be returned. Formatted as an RFC 3339 timestamp.

  • parameter fileId

    The ID of the file.

val patch : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> fileId:string -> commentId:string -> GapiDriveV2Model.Comment.t -> GapiConversation.Session.t -> GapiDriveV2Model.Comment.t * GapiConversation.Session.t

Updates an existing comment. 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 fileId

    The ID of the file.

  • parameter commentId

    The ID of the comment.

val update : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> fileId:string -> commentId:string -> GapiDriveV2Model.Comment.t -> GapiConversation.Session.t -> GapiDriveV2Model.Comment.t * GapiConversation.Session.t

Updates an existing comment.

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

    The ID of the comment.