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.



3854
3855
3856
 
# File 'lib/google/apis/drive_v3/classes.rb', line 3854

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

Instance Attribute Details

#background_image_file ⇒ Google::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

Returns:



3791
3792
3793
 
# File 'lib/google/apis/drive_v3/classes.rb', line 3791

def background_image_file
  @background_image_file
end

#background_image_link ⇒ String

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

Returns:

  • (String) 


3796
3797
3798
 
# File 'lib/google/apis/drive_v3/classes.rb', line 3796

def background_image_link
  @background_image_link
end

#capabilities ⇒ Google::Apis::DriveV3::TeamDrive::Capabilities

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

Returns:



3801
3802
3803
 
# File 'lib/google/apis/drive_v3/classes.rb', line 3801

def capabilities
  @capabilities
end

#color_rgb ⇒ String

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) 


3807
3808
3809
 
# File 'lib/google/apis/drive_v3/classes.rb', line 3807

def color_rgb
  @color_rgb
end

#created_time ⇒ DateTime

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

Returns:

  • (DateTime) 


3812
3813
3814
 
# File 'lib/google/apis/drive_v3/classes.rb', line 3812

def created_time
  @created_time
end

#id ⇒ String

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) 


3818
3819
3820
 
# File 'lib/google/apis/drive_v3/classes.rb', line 3818

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


3824
3825
3826
 
# File 'lib/google/apis/drive_v3/classes.rb', line 3824

def kind
  @kind
end

#name ⇒ String

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

Returns:

  • (String) 


3829
3830
3831
 
# File 'lib/google/apis/drive_v3/classes.rb', line 3829

def name
  @name
end

#org_unit_id ⇒ String

The organizational unit of this shared drive. This field is only populated on drives.list responses when the useDomainAdminAccess parameter is set to true. Corresponds to the JSON property orgUnitId

Returns:

  • (String) 


3836
3837
3838
 
# File 'lib/google/apis/drive_v3/classes.rb', line 3836

def org_unit_id
  @org_unit_id
end

#restrictions ⇒ Google::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

Returns:



3842
3843
3844
 
# File 'lib/google/apis/drive_v3/classes.rb', line 3842

def restrictions
  @restrictions
end

#theme_id ⇒ String

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) 


3852
3853
3854
 
# File 'lib/google/apis/drive_v3/classes.rb', line 3852

def theme_id
  @theme_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
 
# File 'lib/google/apis/drive_v3/classes.rb', line 3859

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)
  @org_unit_id = args[:org_unit_id] if args.key?(:org_unit_id)
  @restrictions = args[:restrictions] if args.key?(:restrictions)
  @theme_id = args[:theme_id] if args.key?(:theme_id)
end