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

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

Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see Understand file capabilities.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Capabilities

Returns a new instance of Capabilities.



2284
2285
2286
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2284

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

Instance Attribute Details

#can_accept_ownership ⇒ Boolean Also known as: can_accept_ownership?

Output only. 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) 


1984
1985
1986
 
# File 'lib/google/apis/drive_v3/classes.rb', line 1984

def can_accept_ownership
  @can_accept_ownership
end

#can_add_children ⇒ Boolean Also known as: can_add_children?

Output only. Whether the current user can add children to this folder. This is always false when the item isn't a folder. Corresponds to the JSON property canAddChildren

Returns:

  • (Boolean) 


1991
1992
1993
 
# File 'lib/google/apis/drive_v3/classes.rb', line 1991

def can_add_children
  @can_add_children
end

#can_add_folder_from_another_drive ⇒ Boolean Also known as: can_add_folder_from_another_drive?

Output only. 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 isn't a folder. Only populated for items in shared drives. Corresponds to the JSON property canAddFolderFromAnotherDrive

Returns:

  • (Boolean) 


1999
2000
2001
 
# File 'lib/google/apis/drive_v3/classes.rb', line 1999

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?

Output only. 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) 


2007
2008
2009
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2007

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?

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

Returns:

  • (Boolean) 


2014
2015
2016
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2014

def can_change_copy_requires_writer_permission
  @can_change_copy_requires_writer_permission
end

#can_change_item_download_restriction ⇒ Boolean Also known as: can_change_item_download_restriction?

Output only. Whether the current user can change the owner or organizer- applied download restrictions of the file. Corresponds to the JSON property canChangeItemDownloadRestriction

Returns:

  • (Boolean) 


2021
2022
2023
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2021

def can_change_item_download_restriction
  @can_change_item_download_restriction
end

#can_change_security_update_enabled ⇒ Boolean Also known as: can_change_security_update_enabled?

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

Returns:

  • (Boolean) 


2028
2029
2030
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2028

def can_change_security_update_enabled
  @can_change_security_update_enabled
end

#can_change_viewers_can_copy_content ⇒ Boolean Also known as: can_change_viewers_can_copy_content?

Deprecated: Output only. Corresponds to the JSON property canChangeViewersCanCopyContent

Returns:

  • (Boolean) 


2034
2035
2036
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2034

def can_change_viewers_can_copy_content
  @can_change_viewers_can_copy_content
end

#can_comment ⇒ Boolean Also known as: can_comment?

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

Returns:

  • (Boolean) 


2040
2041
2042
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2040

def can_comment
  @can_comment
end

#can_copy ⇒ Boolean Also known as: can_copy?

Output only. 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 if it's not a folder. Corresponds to the JSON property canCopy

Returns:

  • (Boolean) 


2048
2049
2050
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2048

def can_copy
  @can_copy
end

#can_delete ⇒ Boolean Also known as: can_delete?

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

Returns:

  • (Boolean) 


2054
2055
2056
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2054

def can_delete
  @can_delete
end

#can_delete_children ⇒ Boolean Also known as: can_delete_children?

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

Returns:

  • (Boolean) 


2062
2063
2064
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2062

def can_delete_children
  @can_delete_children
end

#can_disable_inherited_permissions ⇒ Boolean Also known as: can_disable_inherited_permissions?

Whether a user can disable inherited permissions. Corresponds to the JSON property canDisableInheritedPermissions

Returns:

  • (Boolean) 


2068
2069
2070
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2068

def can_disable_inherited_permissions
  @can_disable_inherited_permissions
end

#can_download ⇒ Boolean Also known as: can_download?

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

Returns:

  • (Boolean) 


2074
2075
2076
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2074

def can_download
  @can_download
end

#can_edit ⇒ Boolean Also known as: can_edit?

Output only. 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) 


2082
2083
2084
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2082

def can_edit
  @can_edit
end

#can_enable_inherited_permissions ⇒ Boolean Also known as: can_enable_inherited_permissions?

Whether a user can re-enable inherited permissions. Corresponds to the JSON property canEnableInheritedPermissions

Returns:

  • (Boolean) 


2088
2089
2090
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2088

def can_enable_inherited_permissions
  @can_enable_inherited_permissions
end

#can_list_children ⇒ Boolean Also known as: can_list_children?

Output only. Whether the current user can list the children of this folder. This is always false when the item isn't a folder. Corresponds to the JSON property canListChildren

Returns:

  • (Boolean) 


2095
2096
2097
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2095

def can_list_children
  @can_list_children
end

#can_modify_content ⇒ Boolean Also known as: can_modify_content?

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

Returns:

  • (Boolean) 


2101
2102
2103
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2101

def can_modify_content
  @can_modify_content
end

#can_modify_content_restriction ⇒ Boolean Also known as: can_modify_content_restriction?

Deprecated: Output only. Use one of canModifyEditorContentRestriction, canModifyOwnerContentRestriction, or canRemoveContentRestriction. Corresponds to the JSON property canModifyContentRestriction

Returns:

  • (Boolean) 


2108
2109
2110
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2108

def can_modify_content_restriction
  @can_modify_content_restriction
end

#can_modify_editor_content_restriction ⇒ Boolean Also known as: can_modify_editor_content_restriction?

Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted. Corresponds to the JSON property canModifyEditorContentRestriction

Returns:

  • (Boolean) 


2115
2116
2117
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2115

def can_modify_editor_content_restriction
  @can_modify_editor_content_restriction
end

#can_modify_labels ⇒ Boolean Also known as: can_modify_labels?

Output only. Whether the current user can modify the labels on the file. Corresponds to the JSON property canModifyLabels

Returns:

  • (Boolean) 


2121
2122
2123
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2121

def can_modify_labels
  @can_modify_labels
end

#can_modify_owner_content_restriction ⇒ Boolean Also known as: can_modify_owner_content_restriction?

Output only. Whether the current user can add or modify content restrictions which are owner restricted. Corresponds to the JSON property canModifyOwnerContentRestriction

Returns:

  • (Boolean) 


2128
2129
2130
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2128

def can_modify_owner_content_restriction
  @can_modify_owner_content_restriction
end

#can_move_children_out_of_drive ⇒ Boolean Also known as: can_move_children_out_of_drive?

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

Returns:

  • (Boolean) 


2136
2137
2138
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2136

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: Output only. Use canMoveChildrenOutOfDrive instead. Corresponds to the JSON property canMoveChildrenOutOfTeamDrive

Returns:

  • (Boolean) 


2142
2143
2144
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2142

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?

Output only. Whether the current user can move children of this folder within this drive. This is false when the item isn't 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) 


2151
2152
2153
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2151

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: Output only. Use canMoveChildrenWithinDrive instead. Corresponds to the JSON property canMoveChildrenWithinTeamDrive

Returns:

  • (Boolean) 


2157
2158
2159
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2157

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: Output only. Use canMoveItemOutOfDrive instead. Corresponds to the JSON property canMoveItemIntoTeamDrive

Returns:

  • (Boolean) 


2163
2164
2165
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2163

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?

Output only. 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's being added. Corresponds to the JSON property canMoveItemOutOfDrive

Returns:

  • (Boolean) 


2171
2172
2173
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2171

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: Output only. Use canMoveItemOutOfDrive instead. Corresponds to the JSON property canMoveItemOutOfTeamDrive

Returns:

  • (Boolean) 


2177
2178
2179
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2177

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?

Output only. 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's being added and the parent that is being removed. Corresponds to the JSON property canMoveItemWithinDrive

Returns:

  • (Boolean) 


2185
2186
2187
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2185

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: Output only. Use canMoveItemWithinDrive instead. Corresponds to the JSON property canMoveItemWithinTeamDrive

Returns:

  • (Boolean) 


2191
2192
2193
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2191

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: Output only. Use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. Corresponds to the JSON property canMoveTeamDriveItem

Returns:

  • (Boolean) 


2198
2199
2200
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2198

def can_move_team_drive_item
  @can_move_team_drive_item
end

#can_read_drive ⇒ Boolean Also known as: can_read_drive?

Output only. 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) 


2205
2206
2207
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2205

def can_read_drive
  @can_read_drive
end

#can_read_labels ⇒ Boolean Also known as: can_read_labels?

Output only. Whether the current user can read the labels on the file. Corresponds to the JSON property canReadLabels

Returns:

  • (Boolean) 


2211
2212
2213
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2211

def can_read_labels
  @can_read_labels
end

#can_read_revisions ⇒ Boolean Also known as: can_read_revisions?

Output only. 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 if it's not a folder, can be read. Corresponds to the JSON property canReadRevisions

Returns:

  • (Boolean) 


2219
2220
2221
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2219

def can_read_revisions
  @can_read_revisions
end

#can_read_team_drive ⇒ Boolean Also known as: can_read_team_drive?

Deprecated: Output only. Use canReadDrive instead. Corresponds to the JSON property canReadTeamDrive

Returns:

  • (Boolean) 


2225
2226
2227
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2225

def can_read_team_drive
  @can_read_team_drive
end

#can_remove_children ⇒ Boolean Also known as: can_remove_children?

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

Returns:

  • (Boolean) 


2233
2234
2235
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2233

def can_remove_children
  @can_remove_children
end

#can_remove_content_restriction ⇒ Boolean Also known as: can_remove_content_restriction?

Output only. Whether there's a content restriction on the file that can be removed by the current user. Corresponds to the JSON property canRemoveContentRestriction

Returns:

  • (Boolean) 


2240
2241
2242
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2240

def can_remove_content_restriction
  @can_remove_content_restriction
end

#can_remove_my_drive_parent ⇒ Boolean Also known as: can_remove_my_drive_parent?

Output only. 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) 


2248
2249
2250
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2248

def can_remove_my_drive_parent
  @can_remove_my_drive_parent
end

#can_rename ⇒ Boolean Also known as: can_rename?

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

Returns:

  • (Boolean) 


2254
2255
2256
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2254

def can_rename
  @can_rename
end

#can_share ⇒ Boolean Also known as: can_share?

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

Returns:

  • (Boolean) 


2261
2262
2263
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2261

def can_share
  @can_share
end

#can_trash ⇒ Boolean Also known as: can_trash?

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

Returns:

  • (Boolean) 


2267
2268
2269
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2267

def can_trash
  @can_trash
end

#can_trash_children ⇒ Boolean Also known as: can_trash_children?

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

Returns:

  • (Boolean) 


2275
2276
2277
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2275

def can_trash_children
  @can_trash_children
end

#can_untrash ⇒ Boolean Also known as: can_untrash?

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

Returns:

  • (Boolean) 


2281
2282
2283
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2281

def can_untrash
  @can_untrash
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2289

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_item_download_restriction = args[:can_change_item_download_restriction] if args.key?(:can_change_item_download_restriction)
  @can_change_security_update_enabled = args[:can_change_security_update_enabled] if args.key?(:can_change_security_update_enabled)
  @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_disable_inherited_permissions = args[:can_disable_inherited_permissions] if args.key?(:can_disable_inherited_permissions)
  @can_download = args[:can_download] if args.key?(:can_download)
  @can_edit = args[:can_edit] if args.key?(:can_edit)
  @can_enable_inherited_permissions = args[:can_enable_inherited_permissions] if args.key?(:can_enable_inherited_permissions)
  @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_modify_editor_content_restriction = args[:can_modify_editor_content_restriction] if args.key?(:can_modify_editor_content_restriction)
  @can_modify_labels = args[:can_modify_labels] if args.key?(:can_modify_labels)
  @can_modify_owner_content_restriction = args[:can_modify_owner_content_restriction] if args.key?(:can_modify_owner_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_labels = args[:can_read_labels] if args.key?(:can_read_labels)
  @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_content_restriction = args[:can_remove_content_restriction] if args.key?(:can_remove_content_restriction)
  @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