drive  v2
Classes | Public Member Functions | Static Public Member Functions | List of all members
google_drive_api::TeamDrive Class Reference

#include <team_drive.h>

Inheritance diagram for google_drive_api::TeamDrive:

Classes

class  TeamDriveBackgroundImageFile
 
class  TeamDriveCapabilities
 
class  TeamDriveRestrictions
 

Public Member Functions

 TeamDrive (const Json::Value &storage)
 
 TeamDrive (Json::Value *storage)
 
virtual ~TeamDrive ()
 
const StringPiece GetTypeName () const
 
bool has_background_image_file () const
 
void clear_background_image_file ()
 
const TeamDriveBackgroundImageFile get_background_image_file () const
 
TeamDriveBackgroundImageFile mutable_backgroundImageFile ()
 
bool has_background_image_link () const
 
void clear_background_image_link ()
 
const StringPiece get_background_image_link () const
 
void set_background_image_link (const StringPiece &value)
 
bool has_capabilities () const
 
void clear_capabilities ()
 
const TeamDriveCapabilities get_capabilities () const
 
TeamDriveCapabilities mutable_capabilities ()
 
bool has_color_rgb () const
 
void clear_color_rgb ()
 
const StringPiece get_color_rgb () const
 
void set_color_rgb (const StringPiece &value)
 
bool has_created_date () const
 
void clear_created_date ()
 
client::DateTime get_created_date () const
 
void set_created_date (client::DateTime value)
 
bool has_id () const
 
void clear_id ()
 
const StringPiece get_id () const
 
void set_id (const StringPiece &value)
 
bool has_kind () const
 
void clear_kind ()
 
const StringPiece get_kind () const
 
void set_kind (const StringPiece &value)
 
bool has_name () const
 
void clear_name ()
 
const StringPiece get_name () const
 
void set_name (const StringPiece &value)
 
bool has_restrictions () const
 
void clear_restrictions ()
 
const TeamDriveRestrictions get_restrictions () const
 
TeamDriveRestrictions mutable_restrictions ()
 
bool has_theme_id () const
 
void clear_theme_id ()
 
const StringPiece get_theme_id () const
 
void set_theme_id (const StringPiece &value)
 

Static Public Member Functions

static TeamDriveNew ()
 

Detailed Description

Deprecated: use the drive collection instead.

Constructor & Destructor Documentation

◆ TeamDrive() [1/2]

google_drive_api::TeamDrive::TeamDrive ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ TeamDrive() [2/2]

google_drive_api::TeamDrive::TeamDrive ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~TeamDrive()

google_drive_api::TeamDrive::~TeamDrive ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_background_image_file()

void google_drive_api::TeamDrive::clear_background_image_file ( )
inline

Clears the 'backgroundImageFile' attribute.

◆ clear_background_image_link()

void google_drive_api::TeamDrive::clear_background_image_link ( )
inline

Clears the 'backgroundImageLink' attribute.

◆ clear_capabilities()

void google_drive_api::TeamDrive::clear_capabilities ( )
inline

Clears the 'capabilities' attribute.

◆ clear_color_rgb()

void google_drive_api::TeamDrive::clear_color_rgb ( )
inline

Clears the 'colorRgb' attribute.

◆ clear_created_date()

void google_drive_api::TeamDrive::clear_created_date ( )
inline

Clears the 'createdDate' attribute.

◆ clear_id()

void google_drive_api::TeamDrive::clear_id ( )
inline

Clears the 'id' attribute.

◆ clear_kind()

void google_drive_api::TeamDrive::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_name()

void google_drive_api::TeamDrive::clear_name ( )
inline

Clears the 'name' attribute.

◆ clear_restrictions()

void google_drive_api::TeamDrive::clear_restrictions ( )
inline

Clears the 'restrictions' attribute.

◆ clear_theme_id()

void google_drive_api::TeamDrive::clear_theme_id ( )
inline

Clears the 'themeId' attribute.

◆ get_background_image_file()

const TeamDriveBackgroundImageFile google_drive_api::TeamDrive::get_background_image_file ( ) const
inline

Get a reference to the value of the 'backgroundImageFile' attribute.

◆ get_background_image_link()

const StringPiece google_drive_api::TeamDrive::get_background_image_link ( ) const
inline

Get the value of the 'backgroundImageLink' attribute.

◆ get_capabilities()

const TeamDriveCapabilities google_drive_api::TeamDrive::get_capabilities ( ) const
inline

Get a reference to the value of the 'capabilities' attribute.

◆ get_color_rgb()

const StringPiece google_drive_api::TeamDrive::get_color_rgb ( ) const
inline

Get the value of the 'colorRgb' attribute.

◆ get_created_date()

client::DateTime google_drive_api::TeamDrive::get_created_date ( ) const
inline

Get the value of the 'createdDate' attribute.

◆ get_id()

const StringPiece google_drive_api::TeamDrive::get_id ( ) const
inline

Get the value of the 'id' attribute.

◆ get_kind()

const StringPiece google_drive_api::TeamDrive::get_kind ( ) const
inline

Get the value of the 'kind' attribute.

◆ get_name()

const StringPiece google_drive_api::TeamDrive::get_name ( ) const
inline

Get the value of the 'name' attribute.

◆ get_restrictions()

const TeamDriveRestrictions google_drive_api::TeamDrive::get_restrictions ( ) const
inline

Get a reference to the value of the 'restrictions' attribute.

◆ get_theme_id()

const StringPiece google_drive_api::TeamDrive::get_theme_id ( ) const
inline

Get the value of the 'themeId' attribute.

◆ GetTypeName()

const StringPiece google_drive_api::TeamDrive::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_drive_api::TeamDrive

◆ has_background_image_file()

bool google_drive_api::TeamDrive::has_background_image_file ( ) const
inline

Determine if the 'backgroundImageFile' attribute was set.

Returns
true if the 'backgroundImageFile' attribute was set.

◆ has_background_image_link()

bool google_drive_api::TeamDrive::has_background_image_link ( ) const
inline

Determine if the 'backgroundImageLink' attribute was set.

Returns
true if the 'backgroundImageLink' attribute was set.

◆ has_capabilities()

bool google_drive_api::TeamDrive::has_capabilities ( ) const
inline

Determine if the 'capabilities' attribute was set.

Returns
true if the 'capabilities' attribute was set.

◆ has_color_rgb()

bool google_drive_api::TeamDrive::has_color_rgb ( ) const
inline

Determine if the 'colorRgb' attribute was set.

Returns
true if the 'colorRgb' attribute was set.

◆ has_created_date()

bool google_drive_api::TeamDrive::has_created_date ( ) const
inline

Determine if the 'createdDate' attribute was set.

Returns
true if the 'createdDate' attribute was set.

◆ has_id()

bool google_drive_api::TeamDrive::has_id ( ) const
inline

Determine if the 'id' attribute was set.

Returns
true if the 'id' attribute was set.

◆ has_kind()

bool google_drive_api::TeamDrive::has_kind ( ) const
inline

Determine if the 'kind' attribute was set.

Returns
true if the 'kind' attribute was set.

◆ has_name()

bool google_drive_api::TeamDrive::has_name ( ) const
inline

Determine if the 'name' attribute was set.

Returns
true if the 'name' attribute was set.

◆ has_restrictions()

bool google_drive_api::TeamDrive::has_restrictions ( ) const
inline

Determine if the 'restrictions' attribute was set.

Returns
true if the 'restrictions' attribute was set.

◆ has_theme_id()

bool google_drive_api::TeamDrive::has_theme_id ( ) const
inline

Determine if the 'themeId' attribute was set.

Returns
true if the 'themeId' attribute was set.

◆ mutable_backgroundImageFile()

TeamDriveBackgroundImageFile google_drive_api::TeamDrive::mutable_backgroundImageFile ( )
inline

Gets a reference to a mutable value of the 'backgroundImageFile' property.

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.

Returns
The result can be modified to change the attribute value.

◆ mutable_capabilities()

TeamDriveCapabilities google_drive_api::TeamDrive::mutable_capabilities ( )
inline

Gets a reference to a mutable value of the 'capabilities' property.

Capabilities the current user has on this Team Drive.

Returns
The result can be modified to change the attribute value.

◆ mutable_restrictions()

TeamDriveRestrictions google_drive_api::TeamDrive::mutable_restrictions ( )
inline

Gets a reference to a mutable value of the 'restrictions' property.

A set of restrictions that apply to this Team Drive or items inside this Team Drive.

Returns
The result can be modified to change the attribute value.

◆ New()

TeamDrive * google_drive_api::TeamDrive::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_background_image_link()

void google_drive_api::TeamDrive::set_background_image_link ( const StringPiece &  value)
inline

Change the 'backgroundImageLink' attribute.

A short-lived link to this Team Drive's background image.

Parameters
[in]valueThe new value.

◆ set_color_rgb()

void google_drive_api::TeamDrive::set_color_rgb ( const StringPiece &  value)
inline

Change the 'colorRgb' attribute.

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.

Parameters
[in]valueThe new value.

◆ set_created_date()

void google_drive_api::TeamDrive::set_created_date ( client::DateTime  value)
inline

Change the 'createdDate' attribute.

The time at which the Team Drive was created (RFC 3339 date-time).

Parameters
[in]valueThe new value.

◆ set_id()

void google_drive_api::TeamDrive::set_id ( const StringPiece &  value)
inline

Change the 'id' attribute.

The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.

Parameters
[in]valueThe new value.

◆ set_kind()

void google_drive_api::TeamDrive::set_kind ( const StringPiece &  value)
inline

Change the 'kind' attribute.

This is always drive::teamDrive.

Parameters
[in]valueThe new value.

◆ set_name()

void google_drive_api::TeamDrive::set_name ( const StringPiece &  value)
inline

Change the 'name' attribute.

The name of this Team Drive.

Parameters
[in]valueThe new value.

◆ set_theme_id()

void google_drive_api::TeamDrive::set_theme_id ( const StringPiece &  value)
inline

Change the 'themeId' attribute.

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.

Parameters
[in]valueThe new value.

The documentation for this class was generated from the following files: