Class: Google::Apis::DriveV3::Permission
- Inherits:
-
Object
- Object
- Google::Apis::DriveV3::Permission
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/drive_v3/classes.rb,
generated/google/apis/drive_v3/representations.rb,
generated/google/apis/drive_v3/representations.rb
Overview
A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
Defined Under Namespace
Classes: PermissionDetail, TeamDrivePermissionDetail
Instance Attribute Summary collapse
-
#allow_file_discovery ⇒ Boolean
(also: #allow_file_discovery?)
Whether the permission allows the file to be discovered through search.
-
#deleted ⇒ Boolean
(also: #deleted?)
Whether the account associated with this permission has been deleted.
-
#display_name ⇒ String
The "pretty" name of the value of the permission.
-
#domain ⇒ String
The domain to which this permission refers.
-
#email_address ⇒ String
The email address of the user or group to which this permission refers.
-
#expiration_time ⇒ DateTime
The time at which this permission will expire (RFC 3339 date-time).
-
#id ⇒ String
The ID of this permission.
-
#kind ⇒ String
Identifies what kind of resource this is.
-
#permission_details ⇒ Array<Google::Apis::DriveV3::Permission::PermissionDetail>
Details of whether the permissions on this shared drive item are inherited or directly on this item.
-
#photo_link ⇒ String
A link to the user's profile photo, if available.
-
#role ⇒ String
The role granted by this permission.
-
#team_drive_permission_details ⇒ Array<Google::Apis::DriveV3::Permission::TeamDrivePermissionDetail>
Deprecated - use permissionDetails instead.
-
#type ⇒ String
The type of the grantee.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Permission
constructor
A new instance of Permission.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Permission
Returns a new instance of Permission.
2046 2047 2048 |
# File 'generated/google/apis/drive_v3/classes.rb', line 2046 def initialize(**args) update!(**args) end |
Instance Attribute Details
#allow_file_discovery ⇒ Boolean Also known as: allow_file_discovery?
Whether the permission allows the file to be discovered through search. This
is only applicable for permissions of type domain or anyone.
Corresponds to the JSON property allowFileDiscovery
1953 1954 1955 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1953 def allow_file_discovery @allow_file_discovery end |
#deleted ⇒ Boolean Also known as: deleted?
Whether the account associated with this permission has been deleted. This
field only pertains to user and group permissions.
Corresponds to the JSON property deleted
1960 1961 1962 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1960 def deleted @deleted end |
#display_name ⇒ 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.
Corresponds to the JSON property
displayName
1972 1973 1974 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1972 def display_name @display_name end |
#domain ⇒ String
The domain to which this permission refers.
Corresponds to the JSON property domain
1977 1978 1979 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1977 def domain @domain end |
#email_address ⇒ String
The email address of the user or group to which this permission refers.
Corresponds to the JSON property emailAddress
1982 1983 1984 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1982 def email_address @email_address end |
#expiration_time ⇒ DateTime
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
Corresponds to the JSON property
expirationTime
1991 1992 1993 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1991 def expiration_time @expiration_time end |
#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.
Corresponds to the JSON property id
1998 1999 2000 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1998 def id @id end |
#kind ⇒ String
Identifies what kind of resource this is. Value: the fixed string "drive#
permission".
Corresponds to the JSON property kind
2004 2005 2006 |
# File 'generated/google/apis/drive_v3/classes.rb', line 2004 def kind @kind end |
#permission_details ⇒ Array<Google::Apis::DriveV3::Permission::PermissionDetail>
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.
Corresponds to the JSON property permissionDetails
2011 2012 2013 |
# File 'generated/google/apis/drive_v3/classes.rb', line 2011 def @permission_details end |
#photo_link ⇒ String
A link to the user's profile photo, if available.
Corresponds to the JSON property photoLink
2016 2017 2018 |
# File 'generated/google/apis/drive_v3/classes.rb', line 2016 def photo_link @photo_link end |
#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
Corresponds to the JSON property
role
2028 2029 2030 |
# File 'generated/google/apis/drive_v3/classes.rb', line 2028 def role @role end |
#team_drive_permission_details ⇒ Array<Google::Apis::DriveV3::Permission::TeamDrivePermissionDetail>
Deprecated - use permissionDetails instead.
Corresponds to the JSON property teamDrivePermissionDetails
2033 2034 2035 |
# File 'generated/google/apis/drive_v3/classes.rb', line 2033 def @team_drive_permission_details end |
#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.
Corresponds to the JSON property
type
2044 2045 2046 |
# File 'generated/google/apis/drive_v3/classes.rb', line 2044 def type @type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 |
# File 'generated/google/apis/drive_v3/classes.rb', line 2051 def update!(**args) @allow_file_discovery = args[:allow_file_discovery] if args.key?(:allow_file_discovery) @deleted = args[:deleted] if args.key?(:deleted) @display_name = args[:display_name] if args.key?(:display_name) @domain = args[:domain] if args.key?(:domain) @email_address = args[:email_address] if args.key?(:email_address) @expiration_time = args[:expiration_time] if args.key?(:expiration_time) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @permission_details = args[:permission_details] if args.key?(:permission_details) @photo_link = args[:photo_link] if args.key?(:photo_link) @role = args[:role] if args.key?(:role) @team_drive_permission_details = args[:team_drive_permission_details] if args.key?(:team_drive_permission_details) @type = args[:type] if args.key?(:type) end |