Class: Google::Apis::DriveV3::Permission

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

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

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) ⇒ Permission

Returns a new instance of Permission.



1206
1207
1208
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1206

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

Instance Attribute Details

#allow_file_discovery ⇒ Boolean Also known as: allow_file_discovery?

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

Returns:

  • (Boolean) 


1149
1150
1151
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1149

def allow_file_discovery
  @allow_file_discovery
end

#display_name ⇒ String

A displayable name for users, groups or domains. Corresponds to the JSON property displayName

Returns:

  • (String) 


1155
1156
1157
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1155

def display_name
  @display_name
end

#domain ⇒ String

The domain to which this permission refers. Corresponds to the JSON property domain

Returns:

  • (String) 


1160
1161
1162
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1160

def domain
  @domain
end

#email_address ⇒ String

The email address of the user or group to which this permission refers. Corresponds to the JSON property emailAddress

Returns:

  • (String) 


1165
1166
1167
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1165

def email_address
  @email_address
end

#expiration_time ⇒ DateTime

The time at which this permission will expire (RFC 3339 date-time). Corresponds to the JSON property expirationTime

Returns:

  • (DateTime) 


1170
1171
1172
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1170

def expiration_time
  @expiration_time
end

#id ⇒ String

The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. Corresponds to the JSON property id

Returns:

  • (String) 


1176
1177
1178
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1176

def id
  @id
end

#kind ⇒ String

This is always drive#permission. Corresponds to the JSON property kind

Returns:

  • (String) 


1181
1182
1183
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1181

def kind
  @kind
end

#photo_link ⇒ String

A link to the user's profile photo, if available. Corresponds to the JSON property photoLink

Returns:

  • (String) 


1186
1187
1188
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1186

def photo_link
  @photo_link
end

#role ⇒ String

The role granted by this permission. Valid values are:

  • owner
  • writer
  • commenter
  • reader Corresponds to the JSON property role

Returns:

  • (String) 


1195
1196
1197
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1195

def role
  @role
end

#type ⇒ String

The type of the grantee. Valid values are:

  • user
  • group
  • domain
  • anyone Corresponds to the JSON property type

Returns:

  • (String) 


1204
1205
1206
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1204

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1211

def update!(**args)
  @allow_file_discovery = args[:allow_file_discovery] if args.key?(:allow_file_discovery)
  @display_name = args[:display_name] if args.key?(:display_name)
  @domain = args[:domain] if args.key?(:domain)
  @email_address = args[:email_address] if args.key?(:email_address)
  @expiration_time = args[:expiration_time] if args.key?(:expiration_time)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @photo_link = args[:photo_link] if args.key?(:photo_link)
  @role = args[:role] if args.key?(:role)
  @type = args[:type] if args.key?(:type)
end