Class: Google::Apis::DriveV3::File::Capabilities
- Inherits:
-
Object
- Object
- Google::Apis::DriveV3::File::Capabilities
- 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
-
#can_add_children ⇒ Boolean
(also: #can_add_children?)
Whether the current user can add children to this folder.
-
#can_change_copy_requires_writer_permission ⇒ Boolean
(also: #can_change_copy_requires_writer_permission?)
Whether the current user can change the copyRequiresWriterPermission restriction of this file.
-
#can_change_viewers_can_copy_content ⇒ Boolean
(also: #can_change_viewers_can_copy_content?)
Deprecated Corresponds to the JSON property
canChangeViewersCanCopyContent
. -
#can_comment ⇒ Boolean
(also: #can_comment?)
Whether the current user can comment on this file.
-
#can_copy ⇒ Boolean
(also: #can_copy?)
Whether the current user can copy this file.
-
#can_delete ⇒ Boolean
(also: #can_delete?)
Whether the current user can delete this file.
-
#can_delete_children ⇒ Boolean
(also: #can_delete_children?)
Whether the current user can delete children of this folder.
-
#can_download ⇒ Boolean
(also: #can_download?)
Whether the current user can download this file.
-
#can_edit ⇒ Boolean
(also: #can_edit?)
Whether the current user can edit this file.
-
#can_list_children ⇒ Boolean
(also: #can_list_children?)
Whether the current user can list the children of this folder.
-
#can_modify_content ⇒ Boolean
(also: #can_modify_content?)
Whether the current user can modify the content of this file.
-
#can_move_children_out_of_drive ⇒ Boolean
(also: #can_move_children_out_of_drive?)
Whether the current user can move children of this folder outside of the shared drive.
-
#can_move_children_out_of_team_drive ⇒ Boolean
(also: #can_move_children_out_of_team_drive?)
Deprecated - use canMoveChildrenOutOfDrive instead.
-
#can_move_children_within_drive ⇒ Boolean
(also: #can_move_children_within_drive?)
Whether the current user can move children of this folder within the shared drive.
-
#can_move_children_within_team_drive ⇒ Boolean
(also: #can_move_children_within_team_drive?)
Deprecated - use canMoveChildrenWithinDrive instead.
-
#can_move_item_into_team_drive ⇒ Boolean
(also: #can_move_item_into_team_drive?)
Deprecated - use canMoveItemOutOfDrive instead.
-
#can_move_item_out_of_drive ⇒ Boolean
(also: #can_move_item_out_of_drive?)
Whether the current user can move this item outside of this drive by changing its parent.
-
#can_move_item_out_of_team_drive ⇒ Boolean
(also: #can_move_item_out_of_team_drive?)
Deprecated - use canMoveItemOutOfDrive instead.
-
#can_move_item_within_drive ⇒ Boolean
(also: #can_move_item_within_drive?)
Whether the current user can move this item within this shared drive.
-
#can_move_item_within_team_drive ⇒ Boolean
(also: #can_move_item_within_team_drive?)
Deprecated - use canMoveItemWithinDrive instead.
-
#can_move_team_drive_item ⇒ Boolean
(also: #can_move_team_drive_item?)
Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
-
#can_read_drive ⇒ Boolean
(also: #can_read_drive?)
Whether the current user can read the shared drive to which this file belongs.
-
#can_read_revisions ⇒ Boolean
(also: #can_read_revisions?)
Whether the current user can read the revisions resource of this file.
-
#can_read_team_drive ⇒ Boolean
(also: #can_read_team_drive?)
Deprecated - use canReadDrive instead.
-
#can_remove_children ⇒ Boolean
(also: #can_remove_children?)
Whether the current user can remove children from this folder.
-
#can_rename ⇒ Boolean
(also: #can_rename?)
Whether the current user can rename this file.
-
#can_share ⇒ Boolean
(also: #can_share?)
Whether the current user can modify the sharing settings for this file.
-
#can_trash ⇒ Boolean
(also: #can_trash?)
Whether the current user can move this file to trash.
-
#can_trash_children ⇒ Boolean
(also: #can_trash_children?)
Whether the current user can trash children of this folder.
-
#can_untrash ⇒ Boolean
(also: #can_untrash?)
Whether the current user can restore this file from trash.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Capabilities
constructor
A new instance of Capabilities.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Capabilities
Returns a new instance of Capabilities.
1566 1567 1568 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1566 def initialize(**args) update!(**args) end |
Instance Attribute Details
#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
1368 1369 1370 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1368 def can_add_children @can_add_children 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
1375 1376 1377 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1375 def @can_change_copy_requires_writer_permission end |
#can_change_viewers_can_copy_content ⇒ Boolean Also known as: can_change_viewers_can_copy_content?
Deprecated
Corresponds to the JSON property canChangeViewersCanCopyContent
1381 1382 1383 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1381 def can_change_viewers_can_copy_content @can_change_viewers_can_copy_content end |
#can_comment ⇒ Boolean Also known as: can_comment?
Whether the current user can comment on this file.
Corresponds to the JSON property canComment
1387 1388 1389 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1387 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
1395 1396 1397 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1395 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
1401 1402 1403 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1401 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
1408 1409 1410 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1408 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
1414 1415 1416 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1414 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
1422 1423 1424 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1422 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
1429 1430 1431 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1429 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
1435 1436 1437 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1435 def can_modify_content @can_modify_content 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
1443 1444 1445 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1443 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
1449 1450 1451 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1449 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 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
1457 1458 1459 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1457 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
1463 1464 1465 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1463 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
1469 1470 1471 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1469 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
1477 1478 1479 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1477 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
1483 1484 1485 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1483 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 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
1491 1492 1493 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1491 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
1497 1498 1499 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1497 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
1503 1504 1505 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1503 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
1510 1511 1512 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1510 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
1518 1519 1520 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1518 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
1524 1525 1526 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1524 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
1532 1533 1534 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1532 def can_remove_children @can_remove_children end |
#can_rename ⇒ Boolean Also known as: can_rename?
Whether the current user can rename this file.
Corresponds to the JSON property canRename
1538 1539 1540 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1538 def can_rename @can_rename end |
#can_share ⇒ Boolean Also known as:
Whether the current user can modify the sharing settings for this file.
Corresponds to the JSON property canShare
1544 1545 1546 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1544 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
1550 1551 1552 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1550 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
1557 1558 1559 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1557 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
1563 1564 1565 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1563 def can_untrash @can_untrash end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 |
# File 'generated/google/apis/drive_v3/classes.rb', line 1571 def update!(**args) @can_add_children = args[:can_add_children] if args.key?(:can_add_children) @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_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 |