Class: Google::Apis::DriveV3::Permission

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/drive_v3/classes.rb,
lib/google/apis/drive_v3/representations.rb,
lib/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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Permission

Returns a new instance of Permission.



2643
2644
2645
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2643

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

Returns:

  • (Boolean) 


2533
2534
2535
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2533

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

Returns:

  • (Boolean) 


2540
2541
2542
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2540

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 "your-company.com."
  • anyone - No displayName is present. Corresponds to the JSON property displayName

Returns:

  • (String) 


2552
2553
2554
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2552

def display_name
  @display_name
end

#domain ⇒ String

The domain to which this permission refers. The following options are currently allowed:

  • The entire domain, such as "your-company.com."
  • A target audience, such as "ID.audience.googledomains.com." Corresponds to the JSON property domain

Returns:

  • (String) 


2560
2561
2562
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2560

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

Returns:

  • (String) 


2565
2566
2567
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2565

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 cannot be set on shared drive items.
  • They can only be set on user and group permissions.
  • The time must be in the future.
  • The time cannot be more than one year in the future. Corresponds to the JSON property expirationTime

Returns:

  • (DateTime) 


2575
2576
2577
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2575

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

Returns:

  • (String) 


2582
2583
2584
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2582

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

Returns:

  • (String) 


2588
2589
2590
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2588

def kind
  @kind
end

#pending_owner ⇒ Boolean Also known as: pending_owner?

Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that aren't in a shared drive. Corresponds to the JSON property pendingOwner

Returns:

  • (Boolean) 


2594
2595
2596
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2594

def pending_owner
  @pending_owner
end

#permission_details ⇒ Array<Google::Apis::DriveV3::Permission::PermissionDetail>

Details of whether the permissions on this shared drive item are inherited or are directly on this item. This is an output-only field that's present only for shared drive items. Corresponds to the JSON property permissionDetails

Returns:



2602
2603
2604
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2602

def permission_details
  @permission_details
end

#photo_link ⇒ String

A link to the user's profile photo, if available. Corresponds to the JSON property photoLink

Returns:

  • (String) 


2607
2608
2609
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2607

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

Returns:

  • (String) 


2619
2620
2621
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2619

def role
  @role
end

#team_drive_permission_details ⇒ Array<Google::Apis::DriveV3::Permission::TeamDrivePermissionDetail>

Deprecated - use permissionDetails instead. Corresponds to the JSON property teamDrivePermissionDetails

Returns:



2624
2625
2626
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2624

def team_drive_permission_details
  @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 the anyone type. Corresponds to the JSON property type

Returns:

  • (String) 


2635
2636
2637
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2635

def type
  @type
end

#view ⇒ String

Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. Corresponds to the JSON property view

Returns:

  • (String) 


2641
2642
2643
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2641

def view
  @view
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2648

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)
  @pending_owner = args[:pending_owner] if args.key?(:pending_owner)
  @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)
  @view = args[:view] if args.key?(:view)
end