Class: Google::Apis::DriveV3::TeamDrive

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

Deprecated: use the drive collection instead.

Defined Under Namespace

Classes: BackgroundImageFile, Capabilities, Restrictions

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ TeamDrive

Returns a new instance of TeamDrive.



2681
2682
2683
# File 'lib/google/apis/drive_v3/classes.rb', line 2681

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

Instance Attribute Details

#background_image_fileGoogle::Apis::DriveV3::TeamDrive::BackgroundImageFile

An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive. teamdrives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set. Corresponds to the JSON property backgroundImageFile



2625
2626
2627
# File 'lib/google/apis/drive_v3/classes.rb', line 2625

def background_image_file
  @background_image_file
end

A short-lived link to this Team Drive's background image. Corresponds to the JSON property backgroundImageLink

Returns:

  • (String)


2630
2631
2632
# File 'lib/google/apis/drive_v3/classes.rb', line 2630

def background_image_link
  @background_image_link
end

#capabilitiesGoogle::Apis::DriveV3::TeamDrive::Capabilities

Capabilities the current user has on this Team Drive. Corresponds to the JSON property capabilities



2635
2636
2637
# File 'lib/google/apis/drive_v3/classes.rb', line 2635

def capabilities
  @capabilities
end

#color_rgbString

The color of this Team Drive as an RGB hex string. It can only be set on a drive.teamdrives.update request that does not set themeId. Corresponds to the JSON property colorRgb

Returns:

  • (String)


2641
2642
2643
# File 'lib/google/apis/drive_v3/classes.rb', line 2641

def color_rgb
  @color_rgb
end

#created_timeDateTime

The time at which the Team Drive was created (RFC 3339 date-time). Corresponds to the JSON property createdTime

Returns:

  • (DateTime)


2646
2647
2648
# File 'lib/google/apis/drive_v3/classes.rb', line 2646

def created_time
  @created_time
end

#idString

The ID of this Team Drive which is also the ID of the top level folder of this Team Drive. Corresponds to the JSON property id

Returns:

  • (String)


2652
2653
2654
# File 'lib/google/apis/drive_v3/classes.rb', line 2652

def id
  @id
end

#kindString

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

Returns:

  • (String)


2658
2659
2660
# File 'lib/google/apis/drive_v3/classes.rb', line 2658

def kind
  @kind
end

#nameString

The name of this Team Drive. Corresponds to the JSON property name

Returns:

  • (String)


2663
2664
2665
# File 'lib/google/apis/drive_v3/classes.rb', line 2663

def name
  @name
end

#restrictionsGoogle::Apis::DriveV3::TeamDrive::Restrictions

A set of restrictions that apply to this Team Drive or items inside this Team Drive. Corresponds to the JSON property restrictions



2669
2670
2671
# File 'lib/google/apis/drive_v3/classes.rb', line 2669

def restrictions
  @restrictions
end

#theme_idString

The ID of the theme from which the background image and color will be set. The set of possible teamDriveThemes can be retrieved from a drive.about.get response. When not specified on a drive.teamdrives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile. Corresponds to the JSON property themeId

Returns:

  • (String)


2679
2680
2681
# File 'lib/google/apis/drive_v3/classes.rb', line 2679

def theme_id
  @theme_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
# File 'lib/google/apis/drive_v3/classes.rb', line 2686

def update!(**args)
  @background_image_file = args[:background_image_file] if args.key?(:background_image_file)
  @background_image_link = args[:background_image_link] if args.key?(:background_image_link)
  @capabilities = args[:capabilities] if args.key?(:capabilities)
  @color_rgb = args[:color_rgb] if args.key?(:color_rgb)
  @created_time = args[:created_time] if args.key?(:created_time)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @restrictions = args[:restrictions] if args.key?(:restrictions)
  @theme_id = args[:theme_id] if args.key?(:theme_id)
end