View Source GoogleApi.Drive.V3.Model.Permission (google_api_drive v0.27.1)
A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. Some resource methods (such as permissions.update
) require a permissionId
. Use the permissions.list
method to retrieve the ID for a file, folder, or shared drive.
Attributes
-
allowFileDiscovery
(type:boolean()
, default:nil
) - Whether the permission allows the file to be discovered through search. This is only applicable for permissions of typedomain
oranyone
. -
deleted
(type:boolean()
, default:nil
) - Output only. 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
) - 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
- NodisplayName
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
) - Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources aspermissionId
. IDs should be treated as opaque values. -
kind
(type:String.t
, default:drive#permission
) - Output only. Identifies what kind of resource this is. Value: the fixed string"drive#permission"
. -
pendingOwner
(type:boolean()
, default:nil
) - Whether the account associated with this permission is a pending owner. Only populated foruser
type permissions for files that are not in a shared drive. -
permissionDetails
(type:list(GoogleApi.Drive.V3.Model.PermissionPermissionDetails.t)
, default:nil
) - Output only. 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
) - Output only. 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
) - Output only. Deprecated: Output only. UsepermissionDetails
instead. -
type
(type:String.t
, default:nil
) - The type of the grantee. Valid values are:user
group
domain
anyone
When creating a permission, iftype
isuser
orgroup
, you must provide anemailAddress
for the user or group. Whentype
isdomain
, you must provide adomain
. There isn't extra information required for ananyone
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.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.Drive.V3.Model.Permission{ allowFileDiscovery: boolean() | nil, deleted: boolean() | nil, displayName: String.t() | nil, domain: String.t() | nil, emailAddress: String.t() | nil, expirationTime: DateTime.t() | nil, id: String.t() | nil, kind: String.t() | nil, pendingOwner: boolean() | nil, permissionDetails: [GoogleApi.Drive.V3.Model.PermissionPermissionDetails.t()] | nil, photoLink: String.t() | nil, role: String.t() | nil, teamDrivePermissionDetails: [GoogleApi.Drive.V3.Model.PermissionTeamDrivePermissionDetails.t()] | nil, type: String.t() | nil, view: String.t() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.