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

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

Representation of a Team Drive.

Defined Under Namespace

Classes: BackgroundImageFile, Capabilities

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

Returns a new instance of TeamDrive



1893
1894
1895
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1893

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:



1848
1849
1850
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1848

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) 


1853
1854
1855
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1853

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:



1858
1859
1860
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1858

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) 


1864
1865
1866
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1864

def color_rgb
  @color_rgb
end

#id ⇒ String

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

Returns:

  • (String) 


1870
1871
1872
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1870

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) 


1876
1877
1878
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1876

def kind
  @kind
end

#name ⇒ String

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

Returns:

  • (String) 


1881
1882
1883
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1881

def name
  @name
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) 


1891
1892
1893
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1891

def theme_id
  @theme_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1898

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