GoogleApi.Drive.V3.Model.Permission (google_api_drive v0.20.4) View Source
A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
Attributes
-
allowFileDiscovery
(type:boolean()
, default:nil
) - Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone. -
deleted
(type:boolean()
, default:nil
) - Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. -
displayName
(type:String.t
, default:nil
) - 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.
-
domain
(type:String.t
, default:nil
) - The domain to which this permission refers. -
emailAddress
(type:String.t
, default:nil
) - The email address of the user or group to which this permission refers. -
expirationTime
(type:DateTime.t
, default:nil
) - 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
-
id
(type:String.t
, default:nil
) - 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. -
kind
(type:String.t
, default:drive#permission
) - Identifies what kind of resource this is. Value: the fixed string "drive#permission". -
permissionDetails
(type:list(GoogleApi.Drive.V3.Model.PermissionPermissionDetails.t)
, default:nil
) - 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. -
photoLink
(type:String.t
, default:nil
) - A link to the user's profile photo, if available. -
role
(type:String.t
, default:nil
) - 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
-
teamDrivePermissionDetails
(type:list(GoogleApi.Drive.V3.Model.PermissionTeamDrivePermissionDetails.t)
, default:nil
) - Deprecated - use permissionDetails instead. -
type
(type:String.t
, default:nil
) - 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.
-
view
(type:String.t
, default:nil
) - Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
Link to this section Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Link to this section Types
Specs
t() :: %GoogleApi.Drive.V3.Model.Permission{ allowFileDiscovery: boolean(), deleted: boolean(), displayName: String.t(), domain: String.t(), emailAddress: String.t(), expirationTime: DateTime.t(), id: String.t(), kind: String.t(), permissionDetails: [GoogleApi.Drive.V3.Model.PermissionPermissionDetails.t()], photoLink: String.t(), role: String.t(), teamDrivePermissionDetails: [ GoogleApi.Drive.V3.Model.PermissionTeamDrivePermissionDetails.t() ], type: String.t(), view: String.t() }
Link to this section Functions
Specs
Unwrap a decoded JSON object into its complex fields.