Class: Google::Apis::DriveV2::File::Capabilities

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/drive_v2/classes.rb,
lib/google/apis/drive_v2/representations.rb,
lib/google/apis/drive_v2/representations.rb

Overview

Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Capabilities

Returns a new instance of Capabilities.



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

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#can_accept_ownership ⇒ Boolean Also known as: can_accept_ownership?

Whether the current user is the pending owner of the file. Not populated for shared drive files. Corresponds to the JSON property canAcceptOwnership

Returns:

  • (Boolean) 


2292
2293
2294
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2292

def can_accept_ownership
  @can_accept_ownership
end

#can_add_children ⇒ Boolean Also known as: can_add_children?

Whether the current user can add children to this folder. This is always false when the item is not a folder. Corresponds to the JSON property canAddChildren

Returns:

  • (Boolean) 


2299
2300
2301
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2299

def can_add_children
  @can_add_children
end

#can_add_folder_from_another_drive ⇒ Boolean Also known as: can_add_folder_from_another_drive?

Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives. Corresponds to the JSON property canAddFolderFromAnotherDrive

Returns:

  • (Boolean) 


2307
2308
2309
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2307

def can_add_folder_from_another_drive
  @can_add_folder_from_another_drive
end

#can_add_my_drive_parent ⇒ Boolean Also known as: can_add_my_drive_parent?

Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. Corresponds to the JSON property canAddMyDriveParent

Returns:

  • (Boolean) 


2314
2315
2316
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2314

def can_add_my_drive_parent
  @can_add_my_drive_parent
end

#can_change_copy_requires_writer_permission ⇒ Boolean Also known as: can_change_copy_requires_writer_permission?

Whether the current user can change the copyRequiresWriterPermission restriction of this file. Corresponds to the JSON property canChangeCopyRequiresWriterPermission

Returns:

  • (Boolean) 


2321
2322
2323
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2321

def can_change_copy_requires_writer_permission
  @can_change_copy_requires_writer_permission
end

#can_change_restricted_download ⇒ Boolean Also known as: can_change_restricted_download?

Deprecated Corresponds to the JSON property canChangeRestrictedDownload

Returns:

  • (Boolean) 


2327
2328
2329
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2327

def can_change_restricted_download
  @can_change_restricted_download
end

#can_change_security_update_enabled ⇒ Boolean Also known as: can_change_security_update_enabled?

Whether the current user can change the securityUpdateEnabled field on link share metadata. Corresponds to the JSON property canChangeSecurityUpdateEnabled

Returns:

  • (Boolean) 


2334
2335
2336
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2334

def can_change_security_update_enabled
  @can_change_security_update_enabled
end

#can_comment ⇒ Boolean Also known as: can_comment?

Whether the current user can comment on this file. Corresponds to the JSON property canComment

Returns:

  • (Boolean) 


2340
2341
2342
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2340

def can_comment
  @can_comment
end

#can_copy ⇒ Boolean Also known as: can_copy?

Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. Corresponds to the JSON property canCopy

Returns:

  • (Boolean) 


2348
2349
2350
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2348

def can_copy
  @can_copy
end

#can_delete ⇒ Boolean Also known as: can_delete?

Whether the current user can delete this file. Corresponds to the JSON property canDelete

Returns:

  • (Boolean) 


2354
2355
2356
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2354

def can_delete
  @can_delete
end

#can_delete_children ⇒ Boolean Also known as: can_delete_children?

Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. Corresponds to the JSON property canDeleteChildren

Returns:

  • (Boolean) 


2361
2362
2363
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2361

def can_delete_children
  @can_delete_children
end

#can_download ⇒ Boolean Also known as: can_download?

Whether the current user can download this file. Corresponds to the JSON property canDownload

Returns:

  • (Boolean) 


2367
2368
2369
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2367

def can_download
  @can_download
end

#can_edit ⇒ Boolean Also known as: can_edit?

Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent. Corresponds to the JSON property canEdit

Returns:

  • (Boolean) 


2375
2376
2377
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2375

def can_edit
  @can_edit
end

#can_list_children ⇒ Boolean Also known as: can_list_children?

Whether the current user can list the children of this folder. This is always false when the item is not a folder. Corresponds to the JSON property canListChildren

Returns:

  • (Boolean) 


2382
2383
2384
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2382

def can_list_children
  @can_list_children
end

#can_modify_content ⇒ Boolean Also known as: can_modify_content?

Whether the current user can modify the content of this file. Corresponds to the JSON property canModifyContent

Returns:

  • (Boolean) 


2388
2389
2390
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2388

def can_modify_content
  @can_modify_content
end

#can_modify_content_restriction ⇒ Boolean Also known as: can_modify_content_restriction?

Whether the current user can modify restrictions on content of this file. Corresponds to the JSON property canModifyContentRestriction

Returns:

  • (Boolean) 


2394
2395
2396
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2394

def can_modify_content_restriction
  @can_modify_content_restriction
end

#can_move_children_out_of_drive ⇒ Boolean Also known as: can_move_children_out_of_drive?

Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. Corresponds to the JSON property canMoveChildrenOutOfDrive

Returns:

  • (Boolean) 


2402
2403
2404
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2402

def can_move_children_out_of_drive
  @can_move_children_out_of_drive
end

#can_move_children_out_of_team_drive ⇒ Boolean Also known as: can_move_children_out_of_team_drive?

Deprecated - use canMoveChildrenOutOfDrive instead. Corresponds to the JSON property canMoveChildrenOutOfTeamDrive

Returns:

  • (Boolean) 


2408
2409
2410
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2408

def can_move_children_out_of_team_drive
  @can_move_children_out_of_team_drive
end

#can_move_children_within_drive ⇒ Boolean Also known as: can_move_children_within_drive?

Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. Corresponds to the JSON property canMoveChildrenWithinDrive

Returns:

  • (Boolean) 


2417
2418
2419
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2417

def can_move_children_within_drive
  @can_move_children_within_drive
end

#can_move_children_within_team_drive ⇒ Boolean Also known as: can_move_children_within_team_drive?

Deprecated - use canMoveChildrenWithinDrive instead. Corresponds to the JSON property canMoveChildrenWithinTeamDrive

Returns:

  • (Boolean) 


2423
2424
2425
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2423

def can_move_children_within_team_drive
  @can_move_children_within_team_drive
end

#can_move_item_into_team_drive ⇒ Boolean Also known as: can_move_item_into_team_drive?

Deprecated - use canMoveItemOutOfDrive instead. Corresponds to the JSON property canMoveItemIntoTeamDrive

Returns:

  • (Boolean) 


2429
2430
2431
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2429

def can_move_item_into_team_drive
  @can_move_item_into_team_drive
end

#can_move_item_out_of_drive ⇒ Boolean Also known as: can_move_item_out_of_drive?

Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Corresponds to the JSON property canMoveItemOutOfDrive

Returns:

  • (Boolean) 


2437
2438
2439
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2437

def can_move_item_out_of_drive
  @can_move_item_out_of_drive
end

#can_move_item_out_of_team_drive ⇒ Boolean Also known as: can_move_item_out_of_team_drive?

Deprecated - use canMoveItemOutOfDrive instead. Corresponds to the JSON property canMoveItemOutOfTeamDrive

Returns:

  • (Boolean) 


2443
2444
2445
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2443

def can_move_item_out_of_team_drive
  @can_move_item_out_of_team_drive
end

#can_move_item_within_drive ⇒ Boolean Also known as: can_move_item_within_drive?

Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed. Corresponds to the JSON property canMoveItemWithinDrive

Returns:

  • (Boolean) 


2451
2452
2453
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2451

def can_move_item_within_drive
  @can_move_item_within_drive
end

#can_move_item_within_team_drive ⇒ Boolean Also known as: can_move_item_within_team_drive?

Deprecated - use canMoveItemWithinDrive instead. Corresponds to the JSON property canMoveItemWithinTeamDrive

Returns:

  • (Boolean) 


2457
2458
2459
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2457

def can_move_item_within_team_drive
  @can_move_item_within_team_drive
end

#can_move_team_drive_item ⇒ Boolean Also known as: can_move_team_drive_item?

Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. Corresponds to the JSON property canMoveTeamDriveItem

Returns:

  • (Boolean) 


2463
2464
2465
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2463

def can_move_team_drive_item
  @can_move_team_drive_item
end

#can_read_drive ⇒ Boolean Also known as: can_read_drive?

Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. Corresponds to the JSON property canReadDrive

Returns:

  • (Boolean) 


2470
2471
2472
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2470

def can_read_drive
  @can_read_drive
end

#can_read_revisions ⇒ Boolean Also known as: can_read_revisions?

Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. Corresponds to the JSON property canReadRevisions

Returns:

  • (Boolean) 


2478
2479
2480
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2478

def can_read_revisions
  @can_read_revisions
end

#can_read_team_drive ⇒ Boolean Also known as: can_read_team_drive?

Deprecated - use canReadDrive instead. Corresponds to the JSON property canReadTeamDrive

Returns:

  • (Boolean) 


2484
2485
2486
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2484

def can_read_team_drive
  @can_read_team_drive
end

#can_remove_children ⇒ Boolean Also known as: can_remove_children?

Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. Corresponds to the JSON property canRemoveChildren

Returns:

  • (Boolean) 


2492
2493
2494
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2492

def can_remove_children
  @can_remove_children
end

#can_remove_my_drive_parent ⇒ Boolean Also known as: can_remove_my_drive_parent?

Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files. Corresponds to the JSON property canRemoveMyDriveParent

Returns:

  • (Boolean) 


2499
2500
2501
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2499

def can_remove_my_drive_parent
  @can_remove_my_drive_parent
end

#can_rename ⇒ Boolean Also known as: can_rename?

Whether the current user can rename this file. Corresponds to the JSON property canRename

Returns:

  • (Boolean) 


2505
2506
2507
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2505

def can_rename
  @can_rename
end

#can_share ⇒ Boolean Also known as: can_share?

Whether the current user can modify the sharing settings for this file. Corresponds to the JSON property canShare

Returns:

  • (Boolean) 


2511
2512
2513
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2511

def can_share
  @can_share
end

#can_trash ⇒ Boolean Also known as: can_trash?

Whether the current user can move this file to trash. Corresponds to the JSON property canTrash

Returns:

  • (Boolean) 


2517
2518
2519
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2517

def can_trash
  @can_trash
end

#can_trash_children ⇒ Boolean Also known as: can_trash_children?

Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. Corresponds to the JSON property canTrashChildren

Returns:

  • (Boolean) 


2524
2525
2526
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2524

def can_trash_children
  @can_trash_children
end

#can_untrash ⇒ Boolean Also known as: can_untrash?

Whether the current user can restore this file from trash. Corresponds to the JSON property canUntrash

Returns:

  • (Boolean) 


2530
2531
2532
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2530

def can_untrash
  @can_untrash
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2538

def update!(**args)
  @can_accept_ownership = args[:can_accept_ownership] if args.key?(:can_accept_ownership)
  @can_add_children = args[:can_add_children] if args.key?(:can_add_children)
  @can_add_folder_from_another_drive = args[:can_add_folder_from_another_drive] if args.key?(:can_add_folder_from_another_drive)
  @can_add_my_drive_parent = args[:can_add_my_drive_parent] if args.key?(:can_add_my_drive_parent)
  @can_change_copy_requires_writer_permission = args[:can_change_copy_requires_writer_permission] if args.key?(:can_change_copy_requires_writer_permission)
  @can_change_restricted_download = args[:can_change_restricted_download] if args.key?(:can_change_restricted_download)
  @can_change_security_update_enabled = args[:can_change_security_update_enabled] if args.key?(:can_change_security_update_enabled)
  @can_comment = args[:can_comment] if args.key?(:can_comment)
  @can_copy = args[:can_copy] if args.key?(:can_copy)
  @can_delete = args[:can_delete] if args.key?(:can_delete)
  @can_delete_children = args[:can_delete_children] if args.key?(:can_delete_children)
  @can_download = args[:can_download] if args.key?(:can_download)
  @can_edit = args[:can_edit] if args.key?(:can_edit)
  @can_list_children = args[:can_list_children] if args.key?(:can_list_children)
  @can_modify_content = args[:can_modify_content] if args.key?(:can_modify_content)
  @can_modify_content_restriction = args[:can_modify_content_restriction] if args.key?(:can_modify_content_restriction)
  @can_move_children_out_of_drive = args[:can_move_children_out_of_drive] if args.key?(:can_move_children_out_of_drive)
  @can_move_children_out_of_team_drive = args[:can_move_children_out_of_team_drive] if args.key?(:can_move_children_out_of_team_drive)
  @can_move_children_within_drive = args[:can_move_children_within_drive] if args.key?(:can_move_children_within_drive)
  @can_move_children_within_team_drive = args[:can_move_children_within_team_drive] if args.key?(:can_move_children_within_team_drive)
  @can_move_item_into_team_drive = args[:can_move_item_into_team_drive] if args.key?(:can_move_item_into_team_drive)
  @can_move_item_out_of_drive = args[:can_move_item_out_of_drive] if args.key?(:can_move_item_out_of_drive)
  @can_move_item_out_of_team_drive = args[:can_move_item_out_of_team_drive] if args.key?(:can_move_item_out_of_team_drive)
  @can_move_item_within_drive = args[:can_move_item_within_drive] if args.key?(:can_move_item_within_drive)
  @can_move_item_within_team_drive = args[:can_move_item_within_team_drive] if args.key?(:can_move_item_within_team_drive)
  @can_move_team_drive_item = args[:can_move_team_drive_item] if args.key?(:can_move_team_drive_item)
  @can_read_drive = args[:can_read_drive] if args.key?(:can_read_drive)
  @can_read_revisions = args[:can_read_revisions] if args.key?(:can_read_revisions)
  @can_read_team_drive = args[:can_read_team_drive] if args.key?(:can_read_team_drive)
  @can_remove_children = args[:can_remove_children] if args.key?(:can_remove_children)
  @can_remove_my_drive_parent = args[:can_remove_my_drive_parent] if args.key?(:can_remove_my_drive_parent)
  @can_rename = args[:can_rename] if args.key?(:can_rename)
  @can_share = args[:can_share] if args.key?(:can_share)
  @can_trash = args[:can_trash] if args.key?(:can_trash)
  @can_trash_children = args[:can_trash_children] if args.key?(:can_trash_children)
  @can_untrash = args[:can_untrash] if args.key?(:can_untrash)
end