Class: Google::Apis::DriveV3::File::Capabilities

Inherits:
Object
  • Object
show all
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

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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Capabilities

Returns a new instance of Capabilities.



1587
1588
1589
# File 'generated/google/apis/drive_v3/classes.rb', line 1587

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

Instance Attribute Details

#can_add_childrenBoolean 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)


1375
1376
1377
# File 'generated/google/apis/drive_v3/classes.rb', line 1375

def can_add_children
  @can_add_children
end

#can_add_my_drive_parentBoolean 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)


1382
1383
1384
# File 'generated/google/apis/drive_v3/classes.rb', line 1382

def can_add_my_drive_parent
  @can_add_my_drive_parent
end

#can_change_copy_requires_writer_permissionBoolean 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)


1389
1390
1391
# File 'generated/google/apis/drive_v3/classes.rb', line 1389

def can_change_copy_requires_writer_permission
  @can_change_copy_requires_writer_permission
end

#can_change_viewers_can_copy_contentBoolean Also known as: can_change_viewers_can_copy_content?

Deprecated Corresponds to the JSON property canChangeViewersCanCopyContent

Returns:

  • (Boolean)


1395
1396
1397
# File 'generated/google/apis/drive_v3/classes.rb', line 1395

def can_change_viewers_can_copy_content
  @can_change_viewers_can_copy_content
end

#can_commentBoolean Also known as: can_comment?

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

Returns:

  • (Boolean)


1401
1402
1403
# File 'generated/google/apis/drive_v3/classes.rb', line 1401

def can_comment
  @can_comment
end

#can_copyBoolean 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)


1409
1410
1411
# File 'generated/google/apis/drive_v3/classes.rb', line 1409

def can_copy
  @can_copy
end

#can_deleteBoolean Also known as: can_delete?

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

Returns:

  • (Boolean)


1415
1416
1417
# File 'generated/google/apis/drive_v3/classes.rb', line 1415

def can_delete
  @can_delete
end

#can_delete_childrenBoolean 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)


1422
1423
1424
# File 'generated/google/apis/drive_v3/classes.rb', line 1422

def can_delete_children
  @can_delete_children
end

#can_downloadBoolean Also known as: can_download?

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

Returns:

  • (Boolean)


1428
1429
1430
# File 'generated/google/apis/drive_v3/classes.rb', line 1428

def can_download
  @can_download
end

#can_editBoolean 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)


1436
1437
1438
# File 'generated/google/apis/drive_v3/classes.rb', line 1436

def can_edit
  @can_edit
end

#can_list_childrenBoolean 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)


1443
1444
1445
# File 'generated/google/apis/drive_v3/classes.rb', line 1443

def can_list_children
  @can_list_children
end

#can_modify_contentBoolean 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)


1449
1450
1451
# File 'generated/google/apis/drive_v3/classes.rb', line 1449

def can_modify_content
  @can_modify_content
end

#can_move_children_out_of_driveBoolean 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)


1457
1458
1459
# File 'generated/google/apis/drive_v3/classes.rb', line 1457

def can_move_children_out_of_drive
  @can_move_children_out_of_drive
end

#can_move_children_out_of_team_driveBoolean Also known as: can_move_children_out_of_team_drive?

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

Returns:

  • (Boolean)


1463
1464
1465
# File 'generated/google/apis/drive_v3/classes.rb', line 1463

def can_move_children_out_of_team_drive
  @can_move_children_out_of_team_drive
end

#can_move_children_within_driveBoolean Also known as: can_move_children_within_drive?

Whether the current user can move children of this folder within 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 canMoveChildrenWithinDrive

Returns:

  • (Boolean)


1471
1472
1473
# File 'generated/google/apis/drive_v3/classes.rb', line 1471

def can_move_children_within_drive
  @can_move_children_within_drive
end

#can_move_children_within_team_driveBoolean Also known as: can_move_children_within_team_drive?

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

Returns:

  • (Boolean)


1477
1478
1479
# File 'generated/google/apis/drive_v3/classes.rb', line 1477

def can_move_children_within_team_drive
  @can_move_children_within_team_drive
end

#can_move_item_into_team_driveBoolean Also known as: can_move_item_into_team_drive?

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

Returns:

  • (Boolean)


1483
1484
1485
# File 'generated/google/apis/drive_v3/classes.rb', line 1483

def can_move_item_into_team_drive
  @can_move_item_into_team_drive
end

#can_move_item_out_of_driveBoolean 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)


1491
1492
1493
# File 'generated/google/apis/drive_v3/classes.rb', line 1491

def can_move_item_out_of_drive
  @can_move_item_out_of_drive
end

#can_move_item_out_of_team_driveBoolean Also known as: can_move_item_out_of_team_drive?

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

Returns:

  • (Boolean)


1497
1498
1499
# File 'generated/google/apis/drive_v3/classes.rb', line 1497

def can_move_item_out_of_team_drive
  @can_move_item_out_of_team_drive
end

#can_move_item_within_driveBoolean Also known as: can_move_item_within_drive?

Whether the current user can move this item within this shared drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Only populated for items in shared drives. Corresponds to the JSON property canMoveItemWithinDrive

Returns:

  • (Boolean)


1505
1506
1507
# File 'generated/google/apis/drive_v3/classes.rb', line 1505

def can_move_item_within_drive
  @can_move_item_within_drive
end

#can_move_item_within_team_driveBoolean Also known as: can_move_item_within_team_drive?

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

Returns:

  • (Boolean)


1511
1512
1513
# File 'generated/google/apis/drive_v3/classes.rb', line 1511

def can_move_item_within_team_drive
  @can_move_item_within_team_drive
end

#can_move_team_drive_itemBoolean Also known as: can_move_team_drive_item?

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

Returns:

  • (Boolean)


1517
1518
1519
# File 'generated/google/apis/drive_v3/classes.rb', line 1517

def can_move_team_drive_item
  @can_move_team_drive_item
end

#can_read_driveBoolean 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)


1524
1525
1526
# File 'generated/google/apis/drive_v3/classes.rb', line 1524

def can_read_drive
  @can_read_drive
end

#can_read_revisionsBoolean 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)


1532
1533
1534
# File 'generated/google/apis/drive_v3/classes.rb', line 1532

def can_read_revisions
  @can_read_revisions
end

#can_read_team_driveBoolean Also known as: can_read_team_drive?

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

Returns:

  • (Boolean)


1538
1539
1540
# File 'generated/google/apis/drive_v3/classes.rb', line 1538

def can_read_team_drive
  @can_read_team_drive
end

#can_remove_childrenBoolean 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)


1546
1547
1548
# File 'generated/google/apis/drive_v3/classes.rb', line 1546

def can_remove_children
  @can_remove_children
end

#can_remove_my_drive_parentBoolean 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)


1553
1554
1555
# File 'generated/google/apis/drive_v3/classes.rb', line 1553

def can_remove_my_drive_parent
  @can_remove_my_drive_parent
end

#can_renameBoolean Also known as: can_rename?

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

Returns:

  • (Boolean)


1559
1560
1561
# File 'generated/google/apis/drive_v3/classes.rb', line 1559

def can_rename
  @can_rename
end

#can_shareBoolean 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)


1565
1566
1567
# File 'generated/google/apis/drive_v3/classes.rb', line 1565

def can_share
  @can_share
end

#can_trashBoolean Also known as: can_trash?

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

Returns:

  • (Boolean)


1571
1572
1573
# File 'generated/google/apis/drive_v3/classes.rb', line 1571

def can_trash
  @can_trash
end

#can_trash_childrenBoolean 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)


1578
1579
1580
# File 'generated/google/apis/drive_v3/classes.rb', line 1578

def can_trash_children
  @can_trash_children
end

#can_untrashBoolean Also known as: can_untrash?

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

Returns:

  • (Boolean)


1584
1585
1586
# File 'generated/google/apis/drive_v3/classes.rb', line 1584

def can_untrash
  @can_untrash
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
# File 'generated/google/apis/drive_v3/classes.rb', line 1592

def update!(**args)
  @can_add_children = args[:can_add_children] if args.key?(:can_add_children)
  @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_viewers_can_copy_content = args[:can_change_viewers_can_copy_content] if args.key?(:can_change_viewers_can_copy_content)
  @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_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