package gapi-ocaml

  1. Overview
  2. Docs
package gapi-ocaml
Legend:
Library
Module
Module type
Parameter
Class
Class type
module TeamDrivePermissionDetails : sig ... end
module PermissionDetails : sig ... end
type t = {
  1. allowFileDiscovery : bool;
    (*

    Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.

    *)
  2. deleted : bool;
    (*

    Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

    *)
  3. displayName : string;
    (*

    The "pretty" name of the value of the permission. The following is a list of examples for each type of permission:

    • user - User's full name, as defined for their Google account, such as "Joe Smith."
    • group - Name of the Google Group, such as "The Company Administrators."
    • domain - String domain name, such as "thecompany.com."
    • anyone - No displayName is present.
    *)
  4. domain : string;
    (*

    The domain to which this permission refers.

    *)
  5. emailAddress : string;
    (*

    The email address of the user or group to which this permission refers.

    *)
  6. expirationTime : GapiDate.t;
    (*

    The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions:

    • They can only be set on user and group permissions
    • The time must be in the future
    • The time cannot be more than a year in the future
    *)
  7. id : string;
    (*

    The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.

    *)
  8. kind : string;
    (*

    Identifies what kind of resource this is. Value: the fixed string "drive#permission".

    *)
  9. permissionDetails : PermissionDetails.t list;
    (*

    Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.

    *)
  10. role : string;
    (*

    The role granted by this permission. While new values may be supported in the future, the following are currently allowed:

    • owner
    • organizer
    • fileOrganizer
    • writer
    • commenter
    • reader
    *)
  11. teamDrivePermissionDetails : TeamDrivePermissionDetails.t list;
    (*

    Deprecated - use permissionDetails instead.

    *)
  12. _type : string;
    (*

    The type of the grantee. Valid values are:

    • user
    • group
    • domain
    • anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for a anyone type.
    *)
}
val allowFileDiscovery : (t, bool) GapiLens.t
val deleted : (t, bool) GapiLens.t
val displayName : (t, string) GapiLens.t
val domain : (t, string) GapiLens.t
val emailAddress : (t, string) GapiLens.t
val expirationTime : (t, GapiDate.t) GapiLens.t
val id : (t, string) GapiLens.t
val kind : (t, string) GapiLens.t
val permissionDetails : (t, PermissionDetails.t list) GapiLens.t
val role : (t, string) GapiLens.t
val teamDrivePermissionDetails : (t, TeamDrivePermissionDetails.t list) GapiLens.t
val _type : (t, string) GapiLens.t
val empty : t
val render : t -> GapiJson.json_data_model list
val parse : t -> GapiJson.json_data_model -> t
val to_data_model : t -> GapiJson.json_data_model
val of_data_model : GapiJson.json_data_model -> t