class GoogleDrive::Permission

Overview

A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.

Included Modules

Defined in:

google_drive/models/permission.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(*, allow_file_discovery : Bool | Nil = nil, deleted : Bool | Nil = nil, display_name : String | Nil = nil, domain : String | Nil = nil, email_address : String | Nil = nil, expiration_time : Time | Nil = nil, id : String | Nil = nil, kind : String | Nil = "drive#permission", pending_owner : Bool | Nil = nil, permission_details : Array(GoogleDrive::PermissionPermissionDetailsInner) | Nil = nil, photo_link : String | Nil = nil, role : String | Nil = nil, team_drive_permission_details : Array(GoogleDrive::PermissionTeamDrivePermissionDetailsInner) | Nil = nil, _type : String | Nil = nil, view : String | 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 _type : String | Nil #

The type of the grantee. Valid values are: - user - group - domain - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for a anyone type.


[View source]
def _type=(new_value : String | Nil) #

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


[View source]
def allow_file_discovery : Bool | Nil #

Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.


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

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


[View source]
def deleted : Bool | Nil #

Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.


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

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


[View source]
def display_name : String | Nil #

The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: - user - User's full name, as defined for their Google account, such as "Joe Smith." - group - Name of the Google Group, such as "The Company Administrators." - domain - String domain name, such as "thecompany.com." - anyone - No displayName is present.


[View source]
def display_name=(new_value : String | Nil) #

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


[View source]
def domain : String | Nil #

The domain to which this permission refers.


[View source]
def domain=(new_value : String | Nil) #

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


[View source]
def email_address : String | Nil #

The email address of the user or group to which this permission refers.


[View source]
def email_address=(new_value : String | Nil) #

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


[View source]
def expiration_time : Time | Nil #

The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They cannot be set on shared drive items - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future


[View source]
def expiration_time=(new_value : Time | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] expiration_time 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 id : String | Nil #

The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.


[View source]
def id=(new_value : String | Nil) #

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


[View source]
def kind : String | Nil #

Identifies what kind of resource this is. Value: the fixed string "drive#permission".


[View source]
def kind=(new_value : String | Nil) #

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


[View source]
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 pending_owner : Bool | Nil #

Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.


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

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


[View source]
def permission_details : Array(GoogleDrive::PermissionPermissionDetailsInner) | Nil #

Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.


[View source]
def permission_details=(new_value : Array(GoogleDrive::PermissionPermissionDetailsInner) | Nil) #

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


[View source]
def photo_link : String | Nil #

A link to the user's profile photo, if available.


[View source]
def photo_link=(new_value : String | Nil) #

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


[View source]
def role : String | Nil #

The role granted by this permission. While new values may be supported in the future, the following are currently allowed: - owner - organizer - fileOrganizer - writer - commenter - reader


[View source]
def role=(new_value : String | Nil) #

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


[View source]
def team_drive_permission_details : Array(GoogleDrive::PermissionTeamDrivePermissionDetailsInner) | Nil #

Deprecated - use permissionDetails instead.


[View source]
def team_drive_permission_details=(new_value : Array(GoogleDrive::PermissionTeamDrivePermissionDetailsInner) | Nil) #

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


[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]
def view : String | Nil #

Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.


[View source]
def view=(new_value : String | Nil) #

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


[View source]