Class: Google::Apis::DriveV3::App

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

The apps resource provides a list of apps that a user has installed, with information about each app's supported MIME types, file extensions, and other details. Some resource methods (such as apps.get) require an appId. Use the apps.list method to retrieve the ID for an installed application.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ App

Returns a new instance of App.



372
373
374
 
# File 'lib/google/apis/drive_v3/classes.rb', line 372

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

Instance Attribute Details

#authorized ⇒ Boolean Also known as: authorized?

Whether the app is authorized to access data on the user's Drive. Corresponds to the JSON property authorized

Returns:

  • (Boolean) 


240
241
242
 
# File 'lib/google/apis/drive_v3/classes.rb', line 240

def authorized
  @authorized
end

#create_in_folder_template ⇒ String

The template URL to create a file with this app in a given folder. The template contains the folderId to be replaced by the folder ID house the new file. Corresponds to the JSON property createInFolderTemplate

Returns:

  • (String) 


248
249
250
 
# File 'lib/google/apis/drive_v3/classes.rb', line 248

def create_in_folder_template
  @create_in_folder_template
end

#create_url ⇒ String

The URL to create a file with this app. Corresponds to the JSON property createUrl

Returns:

  • (String) 


253
254
255
 
# File 'lib/google/apis/drive_v3/classes.rb', line 253

def create_url
  @create_url
end

#has_drive_wide_scope ⇒ Boolean Also known as: has_drive_wide_scope?

Whether the app has Drive-wide scope. An app with Drive-wide scope can access all files in the user's Drive. Corresponds to the JSON property hasDriveWideScope

Returns:

  • (Boolean) 


259
260
261
 
# File 'lib/google/apis/drive_v3/classes.rb', line 259

def has_drive_wide_scope
  @has_drive_wide_scope
end

#icons ⇒ Array<Google::Apis::DriveV3::AppIcons>

The various icons for the app. Corresponds to the JSON property icons

Returns:



265
266
267
 
# File 'lib/google/apis/drive_v3/classes.rb', line 265

def icons
  @icons
end

#id ⇒ String

The ID of the app. Corresponds to the JSON property id

Returns:

  • (String) 


270
271
272
 
# File 'lib/google/apis/drive_v3/classes.rb', line 270

def id
  @id
end

#installed ⇒ Boolean Also known as: installed?

Whether the app is installed. Corresponds to the JSON property installed

Returns:

  • (Boolean) 


275
276
277
 
# File 'lib/google/apis/drive_v3/classes.rb', line 275

def installed
  @installed
end

#kind ⇒ String

Output only. Identifies what kind of resource this is. Value: the fixed string "drive#app". Corresponds to the JSON property kind

Returns:

  • (String) 


282
283
284
 
# File 'lib/google/apis/drive_v3/classes.rb', line 282

def kind
  @kind
end

#long_description ⇒ String

A long description of the app. Corresponds to the JSON property longDescription

Returns:

  • (String) 


287
288
289
 
# File 'lib/google/apis/drive_v3/classes.rb', line 287

def long_description
  @long_description
end

#name ⇒ String

The name of the app. Corresponds to the JSON property name

Returns:

  • (String) 


292
293
294
 
# File 'lib/google/apis/drive_v3/classes.rb', line 292

def name
  @name
end

#object_type ⇒ String

The type of object this app creates such as a Chart. If empty, the app name should be used instead. Corresponds to the JSON property objectType

Returns:

  • (String) 


298
299
300
 
# File 'lib/google/apis/drive_v3/classes.rb', line 298

def object_type
  @object_type
end

#open_url_template ⇒ String

The template URL for opening files with this app. The template contains ids or exportIds to be replaced by the actual file IDs. For more information, see Open Files for the full documentation. Corresponds to the JSON property openUrlTemplate

Returns:

  • (String) 


305
306
307
 
# File 'lib/google/apis/drive_v3/classes.rb', line 305

def open_url_template
  @open_url_template
end

#primary_file_extensions ⇒ Array<String>

The list of primary file extensions. Corresponds to the JSON property primaryFileExtensions

Returns:

  • (Array<String>) 


310
311
312
 
# File 'lib/google/apis/drive_v3/classes.rb', line 310

def primary_file_extensions
  @primary_file_extensions
end

#primary_mime_types ⇒ Array<String>

The list of primary MIME types. Corresponds to the JSON property primaryMimeTypes

Returns:

  • (Array<String>) 


315
316
317
 
# File 'lib/google/apis/drive_v3/classes.rb', line 315

def primary_mime_types
  @primary_mime_types
end

#product_id ⇒ String

The ID of the product listing for this app. Corresponds to the JSON property productId

Returns:

  • (String) 


320
321
322
 
# File 'lib/google/apis/drive_v3/classes.rb', line 320

def product_id
  @product_id
end

#product_url ⇒ String

A link to the product listing for this app. Corresponds to the JSON property productUrl

Returns:

  • (String) 


325
326
327
 
# File 'lib/google/apis/drive_v3/classes.rb', line 325

def product_url
  @product_url
end

#secondary_file_extensions ⇒ Array<String>

The list of secondary file extensions. Corresponds to the JSON property secondaryFileExtensions

Returns:

  • (Array<String>) 


330
331
332
 
# File 'lib/google/apis/drive_v3/classes.rb', line 330

def secondary_file_extensions
  @secondary_file_extensions
end

#secondary_mime_types ⇒ Array<String>

The list of secondary MIME types. Corresponds to the JSON property secondaryMimeTypes

Returns:

  • (Array<String>) 


335
336
337
 
# File 'lib/google/apis/drive_v3/classes.rb', line 335

def secondary_mime_types
  @secondary_mime_types
end

#short_description ⇒ String

A short description of the app. Corresponds to the JSON property shortDescription

Returns:

  • (String) 


340
341
342
 
# File 'lib/google/apis/drive_v3/classes.rb', line 340

def short_description
  @short_description
end

#supports_create ⇒ Boolean Also known as: supports_create?

Whether this app supports creating objects. Corresponds to the JSON property supportsCreate

Returns:

  • (Boolean) 


345
346
347
 
# File 'lib/google/apis/drive_v3/classes.rb', line 345

def supports_create
  @supports_create
end

#supports_import ⇒ Boolean Also known as: supports_import?

Whether this app supports importing from Google Docs. Corresponds to the JSON property supportsImport

Returns:

  • (Boolean) 


351
352
353
 
# File 'lib/google/apis/drive_v3/classes.rb', line 351

def supports_import
  @supports_import
end

#supports_multi_open ⇒ Boolean Also known as: supports_multi_open?

Whether this app supports opening more than one file. Corresponds to the JSON property supportsMultiOpen

Returns:

  • (Boolean) 


357
358
359
 
# File 'lib/google/apis/drive_v3/classes.rb', line 357

def supports_multi_open
  @supports_multi_open
end

#supports_offline_create ⇒ Boolean Also known as: supports_offline_create?

Whether this app supports creating files when offline. Corresponds to the JSON property supportsOfflineCreate

Returns:

  • (Boolean) 


363
364
365
 
# File 'lib/google/apis/drive_v3/classes.rb', line 363

def supports_offline_create
  @supports_offline_create
end

#use_by_default ⇒ Boolean Also known as: use_by_default?

Whether the app is selected as the default handler for the types it supports. Corresponds to the JSON property useByDefault

Returns:

  • (Boolean) 


369
370
371
 
# File 'lib/google/apis/drive_v3/classes.rb', line 369

def use_by_default
  @use_by_default
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/google/apis/drive_v3/classes.rb', line 377

def update!(**args)
  @authorized = args[:authorized] if args.key?(:authorized)
  @create_in_folder_template = args[:create_in_folder_template] if args.key?(:create_in_folder_template)
  @create_url = args[:create_url] if args.key?(:create_url)
  @has_drive_wide_scope = args[:has_drive_wide_scope] if args.key?(:has_drive_wide_scope)
  @icons = args[:icons] if args.key?(:icons)
  @id = args[:id] if args.key?(:id)
  @installed = args[:installed] if args.key?(:installed)
  @kind = args[:kind] if args.key?(:kind)
  @long_description = args[:long_description] if args.key?(:long_description)
  @name = args[:name] if args.key?(:name)
  @object_type = args[:object_type] if args.key?(:object_type)
  @open_url_template = args[:open_url_template] if args.key?(:open_url_template)
  @primary_file_extensions = args[:primary_file_extensions] if args.key?(:primary_file_extensions)
  @primary_mime_types = args[:primary_mime_types] if args.key?(:primary_mime_types)
  @product_id = args[:product_id] if args.key?(:product_id)
  @product_url = args[:product_url] if args.key?(:product_url)
  @secondary_file_extensions = args[:secondary_file_extensions] if args.key?(:secondary_file_extensions)
  @secondary_mime_types = args[:secondary_mime_types] if args.key?(:secondary_mime_types)
  @short_description = args[:short_description] if args.key?(:short_description)
  @supports_create = args[:supports_create] if args.key?(:supports_create)
  @supports_import = args[:supports_import] if args.key?(:supports_import)
  @supports_multi_open = args[:supports_multi_open] if args.key?(:supports_multi_open)
  @supports_offline_create = args[:supports_offline_create] if args.key?(:supports_offline_create)
  @use_by_default = args[:use_by_default] if args.key?(:use_by_default)
end