package gapi-ocaml

  1. Overview
  2. Docs
package gapi-ocaml
Legend:
Library
Module
Module type
Parameter
Class
Class type
val create : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?transferOwnership:bool -> ?emailMessage:string -> ?sendNotificationEmail:bool -> fileId:string -> GapiDriveV3Model.Permission.t -> GapiConversation.Session.t -> GapiDriveV3Model.Permission.t * GapiConversation.Session.t

Creates a permission for a file.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter transferOwnership

    Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect.

  • parameter emailMessage

    A custom message to include in the notification email.

  • parameter sendNotificationEmail

    Whether to send a notification email when sharing to users or groups. This defaults to true for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers.

  • parameter fileId

    The ID of the file.

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

Deletes a permission.

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

    The ID of the permission.

val get : ?base_url:string -> ?etag:string -> ?std_params:GapiService.StandardParameters.t -> fileId:string -> permissionId:string -> GapiConversation.Session.t -> GapiDriveV3Model.Permission.t * GapiConversation.Session.t

Gets a permission 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 fileId

    The ID of the file.

  • parameter permissionId

    The ID of the permission.

Lists a file's permissions.

  • 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 update : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?removeExpiration:bool -> ?transferOwnership:bool -> fileId:string -> permissionId:string -> GapiDriveV3Model.Permission.t -> GapiConversation.Session.t -> GapiDriveV3Model.Permission.t * GapiConversation.Session.t

Updates a permission 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 removeExpiration

    Whether to remove the expiration date.

  • parameter transferOwnership

    Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect.

  • parameter fileId

    The ID of the file.

  • parameter permissionId

    The ID of the permission.