package gapi-ocaml

  1. Overview
  2. Docs
package gapi-ocaml
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module GapiDriveV3Model.PermissionSource

Sourcemodule PermissionDetails : sig ... end
Sourcetype t = {
  1. id : string;
    (*

    Output only. 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.

    *)
  2. displayName : string;
    (*

    Output only. 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.

    *)
  3. _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 an `anyone` type.

    *)
  4. kind : string;
    (*

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

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

    Output only. Details of whether the permissions on this item are inherited or directly on this item.

    *)
  6. emailAddress : string;
    (*

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

    *)
  7. 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`

    *)
  8. allowFileDiscovery : bool;
    (*

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

    *)
  9. domain : string;
    (*

    The domain to which this permission refers.

    *)
  10. 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

    *)
  11. teamDrivePermissionDetails : TeamDrivePermissionDetails.t list;
    (*

    Output only. Deprecated: Output only. Use `permissionDetails` instead.

    *)
  12. deleted : bool;
    (*

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

    *)
  13. view : string;
    (*

    Indicates the view for this permission. Only populated for permissions that belong to a view. published and metadata are the only supported values. - published: The permission's role is published_reader. - metadata: The item is only visible to the metadata view because the item has limited access and the scope has at least read access to the parent. Note: The metadata view is currently only supported on folders.

    *)
  14. pendingOwner : bool;
    (*

    Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.

    *)
  15. inheritedPermissionsDisabled : bool;
    (*

    When true, only organizers, owners, and users with permissions added directly on the item can access it.

    *)
}
Sourceval id : (t, string) GapiLens.t
Sourceval displayName : (t, string) GapiLens.t
Sourceval _type : (t, string) GapiLens.t
Sourceval kind : (t, string) GapiLens.t
Sourceval permissionDetails : (t, PermissionDetails.t list) GapiLens.t
Sourceval emailAddress : (t, string) GapiLens.t
Sourceval role : (t, string) GapiLens.t
Sourceval allowFileDiscovery : (t, bool) GapiLens.t
Sourceval domain : (t, string) GapiLens.t
Sourceval expirationTime : (t, GapiDate.t) GapiLens.t
Sourceval teamDrivePermissionDetails : (t, TeamDrivePermissionDetails.t list) GapiLens.t
Sourceval deleted : (t, bool) GapiLens.t
Sourceval view : (t, string) GapiLens.t
Sourceval pendingOwner : (t, bool) GapiLens.t
Sourceval inheritedPermissionsDisabled : (t, bool) GapiLens.t
Sourceval empty : t
Sourceval render : t -> GapiJson.json_data_model list
Sourceval to_data_model : t -> GapiJson.json_data_model
Sourceval of_data_model : GapiJson.json_data_model -> t