Class: Google::Apis::DriveV2::TeamDrive

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

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



3013
3014
3015
# File 'generated/google/apis/drive_v2/classes.rb', line 3013

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

Instance Attribute Details

#background_image_fileGoogle::Apis::DriveV2::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



2964
2965
2966
# File 'generated/google/apis/drive_v2/classes.rb', line 2964

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)


2969
2970
2971
# File 'generated/google/apis/drive_v2/classes.rb', line 2969

def background_image_link
  @background_image_link
end

#capabilitiesGoogle::Apis::DriveV2::TeamDrive::Capabilities

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



2974
2975
2976
# File 'generated/google/apis/drive_v2/classes.rb', line 2974

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)


2980
2981
2982
# File 'generated/google/apis/drive_v2/classes.rb', line 2980

def color_rgb
  @color_rgb
end

#created_dateDateTime

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

Returns:

  • (DateTime)


2985
2986
2987
# File 'generated/google/apis/drive_v2/classes.rb', line 2985

def created_date
  @created_date
end

#idString

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)


2991
2992
2993
# File 'generated/google/apis/drive_v2/classes.rb', line 2991

def id
  @id
end

#kindString

This is always drive#teamDrive Corresponds to the JSON property kind

Returns:

  • (String)


2996
2997
2998
# File 'generated/google/apis/drive_v2/classes.rb', line 2996

def kind
  @kind
end

#nameString

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

Returns:

  • (String)


3001
3002
3003
# File 'generated/google/apis/drive_v2/classes.rb', line 3001

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


3011
3012
3013
# File 'generated/google/apis/drive_v2/classes.rb', line 3011

def theme_id
  @theme_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
# File 'generated/google/apis/drive_v2/classes.rb', line 3018

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_date = args[:created_date] if args.key?(:created_date)
  @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