class GoogleDrive::FileCapabilities

Overview

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

Included Modules

Defined in:

google_drive/models/file_capabilities.cr

Constructors

Instance Method Summary

Instance methods inherited from module OpenApi::Json

after_initialize after_initialize, clone clone, eql?(o : self) eql?, to_hash : Hash(String, JSON::Any) to_hash, to_json_any : JSON::Any to_json_any

Class methods inherited from module OpenApi::Json

build_from_hash(hash : Hash) build_from_hash, build_from_json_any(json_any : JSON::Any) build_from_json_any

Instance methods inherited from module OpenApi::Validatable

list_invalid_properties : Array(String) list_invalid_properties, list_invalid_properties_for(key : String) : Array(String) list_invalid_properties_for, valid? : Bool valid?, validate : Nil validate

Instance methods inherited from module JSON::Serializable

to_hash : JSON::Any to_hash

Class methods inherited from module JSON::Serializable

build_from_hash(hash : JSON::Any) build_from_hash

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(*, can_accept_ownership : Bool | Nil = nil, can_add_children : Bool | Nil = nil, can_add_folder_from_another_drive : Bool | Nil = nil, can_add_my_drive_parent : Bool | Nil = nil, can_change_copy_requires_writer_permission : Bool | Nil = nil, can_change_security_update_enabled : Bool | Nil = nil, can_change_viewers_can_copy_content : Bool | Nil = nil, can_comment : Bool | Nil = nil, can_copy : Bool | Nil = nil, can_delete : Bool | Nil = nil, can_delete_children : Bool | Nil = nil, can_download : Bool | Nil = nil, can_edit : Bool | Nil = nil, can_list_children : Bool | Nil = nil, can_modify_content : Bool | Nil = nil, can_modify_content_restriction : Bool | Nil = nil, can_modify_labels : Bool | Nil = nil, can_move_children_out_of_drive : Bool | Nil = nil, can_move_children_out_of_team_drive : Bool | Nil = nil, can_move_children_within_drive : Bool | Nil = nil, can_move_children_within_team_drive : Bool | Nil = nil, can_move_item_into_team_drive : Bool | Nil = nil, can_move_item_out_of_drive : Bool | Nil = nil, can_move_item_out_of_team_drive : Bool | Nil = nil, can_move_item_within_drive : Bool | Nil = nil, can_move_item_within_team_drive : Bool | Nil = nil, can_move_team_drive_item : Bool | Nil = nil, can_read_drive : Bool | Nil = nil, can_read_labels : Bool | Nil = nil, can_read_revisions : Bool | Nil = nil, can_read_team_drive : Bool | Nil = nil, can_remove_children : Bool | Nil = nil, can_remove_my_drive_parent : Bool | Nil = nil, can_rename : Bool | Nil = nil, can_share : Bool | Nil = nil, can_trash : Bool | Nil = nil, can_trash_children : Bool | Nil = nil, can_untrash : Bool | Nil = nil) #

Initializes the object @param [Hash] attributes Model attributes in the form of hash


[View source]

Instance Method Detail

def ==(other : self) #

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code


def can_accept_ownership : Bool | Nil #

Whether the current user is the pending owner of the file. Not populated for shared drive files.


[View source]
def can_accept_ownership=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_accept_ownership Object to be assigned


[View source]
def can_add_children : Bool | Nil #

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


[View source]
def can_add_children=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_add_children Object to be assigned


[View source]
def can_add_folder_from_another_drive : Bool | Nil #

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.


[View source]
def can_add_folder_from_another_drive=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_add_folder_from_another_drive Object to be assigned


[View source]
def can_add_my_drive_parent : Bool | Nil #

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.


[View source]
def can_add_my_drive_parent=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_add_my_drive_parent Object to be assigned


[View source]
def can_change_copy_requires_writer_permission : Bool | Nil #

Whether the current user can change the copyRequiresWriterPermission restriction of this file.


[View source]
def can_change_copy_requires_writer_permission=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_change_copy_requires_writer_permission Object to be assigned


[View source]
def can_change_security_update_enabled : Bool | Nil #

Whether the current user can change the securityUpdateEnabled field on link share metadata.


[View source]
def can_change_security_update_enabled=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_change_security_update_enabled Object to be assigned


[View source]
def can_change_viewers_can_copy_content : Bool | Nil #

Deprecated


[View source]
def can_change_viewers_can_copy_content=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_change_viewers_can_copy_content Object to be assigned


[View source]
def can_comment : Bool | Nil #

Whether the current user can comment on this file.


[View source]
def can_comment=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_comment Object to be assigned


[View source]
def can_copy : Bool | Nil #

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.


[View source]
def can_copy=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_copy Object to be assigned


[View source]
def can_delete : Bool | Nil #

Whether the current user can delete this file.


[View source]
def can_delete=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_delete Object to be assigned


[View source]
def can_delete_children : Bool | Nil #

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.


[View source]
def can_delete_children=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_delete_children Object to be assigned


[View source]
def can_download : Bool | Nil #

Whether the current user can download this file.


[View source]
def can_download=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_download Object to be assigned


[View source]
def can_edit : Bool | Nil #

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.


[View source]
def can_edit=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_edit Object to be assigned


[View source]
def can_list_children : Bool | Nil #

Whether the current user can list the children of this folder. This is always false when the item is not a folder.


[View source]
def can_list_children=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_list_children Object to be assigned


[View source]
def can_modify_content : Bool | Nil #

Whether the current user can modify the content of this file.


[View source]
def can_modify_content=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_modify_content Object to be assigned


[View source]
def can_modify_content_restriction : Bool | Nil #

Whether the current user can modify restrictions on content of this file.


[View source]
def can_modify_content_restriction=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_modify_content_restriction Object to be assigned


[View source]
def can_modify_labels : Bool | Nil #

Whether the current user can modify the labels on this file.


[View source]
def can_modify_labels=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_modify_labels Object to be assigned


[View source]
def can_move_children_out_of_drive : Bool | Nil #

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.


[View source]
def can_move_children_out_of_drive=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_move_children_out_of_drive Object to be assigned


[View source]
def can_move_children_out_of_team_drive : Bool | Nil #

Deprecated - use canMoveChildrenOutOfDrive instead.


[View source]
def can_move_children_out_of_team_drive=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_move_children_out_of_team_drive Object to be assigned


[View source]
def can_move_children_within_drive : Bool | Nil #

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.


[View source]
def can_move_children_within_drive=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_move_children_within_drive Object to be assigned


[View source]
def can_move_children_within_team_drive : Bool | Nil #

Deprecated - use canMoveChildrenWithinDrive instead.


[View source]
def can_move_children_within_team_drive=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_move_children_within_team_drive Object to be assigned


[View source]
def can_move_item_into_team_drive : Bool | Nil #

Deprecated - use canMoveItemOutOfDrive instead.


[View source]
def can_move_item_into_team_drive=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_move_item_into_team_drive Object to be assigned


[View source]
def can_move_item_out_of_drive : Bool | Nil #

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.


[View source]
def can_move_item_out_of_drive=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_move_item_out_of_drive Object to be assigned


[View source]
def can_move_item_out_of_team_drive : Bool | Nil #

Deprecated - use canMoveItemOutOfDrive instead.


[View source]
def can_move_item_out_of_team_drive=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_move_item_out_of_team_drive Object to be assigned


[View source]
def can_move_item_within_drive : Bool | Nil #

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.


[View source]
def can_move_item_within_drive=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_move_item_within_drive Object to be assigned


[View source]
def can_move_item_within_team_drive : Bool | Nil #

Deprecated - use canMoveItemWithinDrive instead.


[View source]
def can_move_item_within_team_drive=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_move_item_within_team_drive Object to be assigned


[View source]
def can_move_team_drive_item : Bool | Nil #

Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.


[View source]
def can_move_team_drive_item=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_move_team_drive_item Object to be assigned


[View source]
def can_read_drive : Bool | Nil #

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


[View source]
def can_read_drive=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_read_drive Object to be assigned


[View source]
def can_read_labels : Bool | Nil #

Whether the current user can read the labels on this file.


[View source]
def can_read_labels=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_read_labels Object to be assigned


[View source]
def can_read_revisions : Bool | Nil #

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 isn't a folder, can be read.


[View source]
def can_read_revisions=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_read_revisions Object to be assigned


[View source]
def can_read_team_drive : Bool | Nil #

Deprecated - use canReadDrive instead.


[View source]
def can_read_team_drive=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_read_team_drive Object to be assigned


[View source]
def can_remove_children : Bool | Nil #

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.


[View source]
def can_remove_children=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_remove_children Object to be assigned


[View source]
def can_remove_my_drive_parent : Bool | Nil #

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.


[View source]
def can_remove_my_drive_parent=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_remove_my_drive_parent Object to be assigned


[View source]
def can_rename : Bool | Nil #

Whether the current user can rename this file.


[View source]
def can_rename=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_rename Object to be assigned


[View source]
def can_share : Bool | Nil #

Whether the current user can modify the sharing settings for this file.


[View source]
def can_share=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_share Object to be assigned


[View source]
def can_trash : Bool | Nil #

Whether the current user can move this file to trash.


[View source]
def can_trash=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_trash Object to be assigned


[View source]
def can_trash_children : Bool | Nil #

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.


[View source]
def can_trash_children=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_trash_children Object to be assigned


[View source]
def can_untrash : Bool | Nil #

Whether the current user can restore this file from trash.


[View source]
def can_untrash=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] can_untrash Object to be assigned


[View source]
def hash(hasher) #

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code


def list_invalid_properties : Array(String) #

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons


[View source]
def valid? : Bool #

Check to see if the all the properties in the model are valid @return true if the model is valid


[View source]