Class: Google::Apis::DriveV2::App

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/drive_v2/classes.rb,
generated/google/apis/drive_v2/representations.rb,
generated/google/apis/drive_v2/representations.rb

Overview

The apps resource provides a list of the apps that a user has installed, with information about each app's supported MIME types, file extensions, and other details.

Defined Under Namespace

Classes: Icon

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

Returns a new instance of App.


508
509
510
# File 'generated/google/apis/drive_v2/classes.rb', line 508

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

Instance Attribute Details

#authorizedBoolean 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)

377
378
379
# File 'generated/google/apis/drive_v2/classes.rb', line 377

def authorized
  @authorized
end

#create_in_folder_templateString

The template url to create a new file with this app in a given folder. The template will contain folderId to be replaced by the folder to create the new file in. Corresponds to the JSON property createInFolderTemplate

Returns:

  • (String)

385
386
387
# File 'generated/google/apis/drive_v2/classes.rb', line 385

def create_in_folder_template
  @create_in_folder_template
end

#create_urlString

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

Returns:

  • (String)

390
391
392
# File 'generated/google/apis/drive_v2/classes.rb', line 390

def create_url
  @create_url
end

#has_drive_wide_scopeBoolean 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)

396
397
398
# File 'generated/google/apis/drive_v2/classes.rb', line 396

def has_drive_wide_scope
  @has_drive_wide_scope
end

#iconsArray<Google::Apis::DriveV2::App::Icon>

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


402
403
404
# File 'generated/google/apis/drive_v2/classes.rb', line 402

def icons
  @icons
end

#idString

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

Returns:

  • (String)

407
408
409
# File 'generated/google/apis/drive_v2/classes.rb', line 407

def id
  @id
end

#installedBoolean Also known as: installed?

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

Returns:

  • (Boolean)

412
413
414
# File 'generated/google/apis/drive_v2/classes.rb', line 412

def installed
  @installed
end

#kindString

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

Returns:

  • (String)

418
419
420
# File 'generated/google/apis/drive_v2/classes.rb', line 418

def kind
  @kind
end

#long_descriptionString

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

Returns:

  • (String)

423
424
425
# File 'generated/google/apis/drive_v2/classes.rb', line 423

def long_description
  @long_description
end

#nameString

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

Returns:

  • (String)

428
429
430
# File 'generated/google/apis/drive_v2/classes.rb', line 428

def name
  @name
end

#object_typeString

The type of object this app creates (e.g. Chart). If empty, the app name should be used instead. Corresponds to the JSON property objectType

Returns:

  • (String)

434
435
436
# File 'generated/google/apis/drive_v2/classes.rb', line 434

def object_type
  @object_type
end

#open_url_templateString

The template url for opening files with this app. The template will contain ids and/or exportIds to be replaced by the actual file ids. See Open Files for the full documentation. Corresponds to the JSON property openUrlTemplate

Returns:

  • (String)

441
442
443
# File 'generated/google/apis/drive_v2/classes.rb', line 441

def open_url_template
  @open_url_template
end

#primary_file_extensionsArray<String>

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

Returns:

  • (Array<String>)

446
447
448
# File 'generated/google/apis/drive_v2/classes.rb', line 446

def primary_file_extensions
  @primary_file_extensions
end

#primary_mime_typesArray<String>

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

Returns:

  • (Array<String>)

451
452
453
# File 'generated/google/apis/drive_v2/classes.rb', line 451

def primary_mime_types
  @primary_mime_types
end

#product_idString

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

Returns:

  • (String)

456
457
458
# File 'generated/google/apis/drive_v2/classes.rb', line 456

def product_id
  @product_id
end

#product_urlString

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

Returns:

  • (String)

461
462
463
# File 'generated/google/apis/drive_v2/classes.rb', line 461

def product_url
  @product_url
end

#secondary_file_extensionsArray<String>

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

Returns:

  • (Array<String>)

466
467
468
# File 'generated/google/apis/drive_v2/classes.rb', line 466

def secondary_file_extensions
  @secondary_file_extensions
end

#secondary_mime_typesArray<String>

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

Returns:

  • (Array<String>)

471
472
473
# File 'generated/google/apis/drive_v2/classes.rb', line 471

def secondary_mime_types
  @secondary_mime_types
end

#short_descriptionString

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

Returns:

  • (String)

476
477
478
# File 'generated/google/apis/drive_v2/classes.rb', line 476

def short_description
  @short_description
end

#supports_createBoolean Also known as: supports_create?

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

Returns:

  • (Boolean)

481
482
483
# File 'generated/google/apis/drive_v2/classes.rb', line 481

def supports_create
  @supports_create
end

#supports_importBoolean Also known as: supports_import?

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

Returns:

  • (Boolean)

487
488
489
# File 'generated/google/apis/drive_v2/classes.rb', line 487

def supports_import
  @supports_import
end

#supports_multi_openBoolean Also known as: supports_multi_open?

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

Returns:

  • (Boolean)

493
494
495
# File 'generated/google/apis/drive_v2/classes.rb', line 493

def supports_multi_open
  @supports_multi_open
end

#supports_offline_createBoolean Also known as: supports_offline_create?

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

Returns:

  • (Boolean)

499
500
501
# File 'generated/google/apis/drive_v2/classes.rb', line 499

def supports_offline_create
  @supports_offline_create
end

#use_by_defaultBoolean 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)

505
506
507
# File 'generated/google/apis/drive_v2/classes.rb', line 505

def use_by_default
  @use_by_default
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
# File 'generated/google/apis/drive_v2/classes.rb', line 513

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