package gapi-ocaml

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

Deletes a permission from a 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 for the file.

  • parameter permissionId

    The ID for the permission.

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

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

    The ID for the file.

  • parameter permissionId

    The ID for the permission.

val getIdForEmail : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> email:string -> GapiConversation.Session.t -> GapiDriveV2Model.PermissionId.t * GapiConversation.Session.t

Returns the permission ID for an email address.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter email

    The email address for which to return a permission ID

val insert : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?sendNotificationEmails:bool -> ?emailMessage:string -> fileId:string -> GapiDriveV2Model.Permission.t -> GapiConversation.Session.t -> GapiDriveV2Model.Permission.t * GapiConversation.Session.t

Inserts a permission for a file.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter sendNotificationEmails

    Whether to send notification emails when sharing to users or groups. This parameter is ignored and an email is sent if the role is owner.

  • parameter emailMessage

    A custom message to include in notification emails.

  • parameter fileId

    The ID for the file.

Lists a file's permissions.

  • 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 for the file.

val patch : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?removeExpiration:bool -> ?transferOwnership:bool -> fileId:string -> permissionId:string -> GapiDriveV2Model.Permission.t -> GapiConversation.Session.t -> GapiDriveV2Model.Permission.t * GapiConversation.Session.t

Updates a permission using patch semantics.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter removeExpiration

    Whether to remove the expiration date.

  • parameter transferOwnership

    Whether changing a role to 'owner' downgrades the current owners to writers. Does nothing if the specified role is not 'owner'.

  • parameter fileId

    The ID for the file.

  • parameter permissionId

    The ID for the permission.

val update : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?removeExpiration:bool -> ?transferOwnership:bool -> fileId:string -> permissionId:string -> GapiDriveV2Model.Permission.t -> GapiConversation.Session.t -> GapiDriveV2Model.Permission.t * GapiConversation.Session.t

Updates a permission.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter removeExpiration

    Whether to remove the expiration date.

  • parameter transferOwnership

    Whether changing a role to 'owner' downgrades the current owners to writers. Does nothing if the specified role is not 'owner'.

  • parameter fileId

    The ID for the file.

  • parameter permissionId

    The ID for the permission.