#include <drive.h>

Inheritance diagram for google_drive_api::Drive:

Classes
class	DriveBackgroundImageFile

class	DriveCapabilities

class	DriveRestrictions

Public Member Functions
	Drive (const Json::Value &storage)

	Drive (Json::Value *storage)

virtual	~Drive ()

const StringPiece	GetTypeName () const

bool	has_background_image_file () const

void	clear_background_image_file ()

const DriveBackgroundImageFile	get_background_image_file () const

DriveBackgroundImageFile	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 DriveCapabilities	get_capabilities () const

DriveCapabilities	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_hidden () const

void	clear_hidden ()

bool	get_hidden () const

void	set_hidden (bool 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 DriveRestrictions	get_restrictions () const

DriveRestrictions	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 Drive *	New ()

Detailed Description

Representation of a shared drive.

Constructor & Destructor Documentation

◆ Drive() [1/2]

google_drive_api::Drive::Drive ( const Json::Value & storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ Drive() [2/2]

google_drive_api::Drive::Drive ( Json::Value * storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ ~Drive()

google_drive_api::Drive::~Drive ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_background_image_file()

void google_drive_api::Drive::clear_background_image_file ( )

inline

Clears the 'backgroundImageFile' attribute.

◆ clear_background_image_link()

void google_drive_api::Drive::clear_background_image_link ( )

inline

Clears the 'backgroundImageLink' attribute.

◆ clear_capabilities()

void google_drive_api::Drive::clear_capabilities ( )

inline

Clears the 'capabilities' attribute.

◆ clear_color_rgb()

void google_drive_api::Drive::clear_color_rgb ( )

inline

Clears the 'colorRgb' attribute.

◆ clear_created_date()

void google_drive_api::Drive::clear_created_date ( )

inline

Clears the 'createdDate' attribute.

◆ clear_hidden()

void google_drive_api::Drive::clear_hidden ( )

inline

Clears the 'hidden' attribute.

◆ clear_id()

void google_drive_api::Drive::clear_id ( )

inline

Clears the 'id' attribute.

◆ clear_kind()

void google_drive_api::Drive::clear_kind ( )

inline

Clears the 'kind' attribute.

◆ clear_name()

void google_drive_api::Drive::clear_name ( )

inline

Clears the 'name' attribute.

◆ clear_restrictions()

void google_drive_api::Drive::clear_restrictions ( )

inline

Clears the 'restrictions' attribute.

◆ clear_theme_id()

void google_drive_api::Drive::clear_theme_id ( )

inline

Clears the 'themeId' attribute.

◆ get_background_image_file()

const DriveBackgroundImageFile google_drive_api::Drive::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::Drive::get_background_image_link ( ) const

inline

Get the value of the 'backgroundImageLink' attribute.

◆ get_capabilities()

const DriveCapabilities google_drive_api::Drive::get_capabilities ( ) const

inline

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

◆ get_color_rgb()

const StringPiece google_drive_api::Drive::get_color_rgb ( ) const

inline

Get the value of the 'colorRgb' attribute.

◆ get_created_date()

client::DateTime google_drive_api::Drive::get_created_date ( ) const

inline

Get the value of the 'createdDate' attribute.

◆ get_hidden()

bool google_drive_api::Drive::get_hidden ( ) const

inline

Get the value of the 'hidden' attribute.

◆ get_id()

const StringPiece google_drive_api::Drive::get_id ( ) const

inline

Get the value of the 'id' attribute.

◆ get_kind()

const StringPiece google_drive_api::Drive::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

◆ get_name()

const StringPiece google_drive_api::Drive::get_name ( ) const

inline

Get the value of the 'name' attribute.

◆ get_restrictions()

const DriveRestrictions google_drive_api::Drive::get_restrictions ( ) const

inline

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

◆ get_theme_id()

const StringPiece google_drive_api::Drive::get_theme_id ( ) const

inline

Get the value of the 'themeId' attribute.

◆ GetTypeName()

const StringPiece google_drive_api::Drive::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_drive_api::Drive

◆ has_background_image_file()

bool google_drive_api::Drive::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::Drive::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::Drive::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::Drive::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::Drive::has_created_date ( ) const

inline

Determine if the 'createdDate' attribute was set.

Returns: true if the 'createdDate' attribute was set.

◆ has_hidden()

bool google_drive_api::Drive::has_hidden ( ) const

inline

Determine if the 'hidden' attribute was set.

Returns: true if the 'hidden' attribute was set.

◆ has_id()

bool google_drive_api::Drive::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::Drive::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::Drive::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::Drive::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::Drive::has_theme_id ( ) const

inline

Determine if the 'themeId' attribute was set.

Returns: true if the 'themeId' attribute was set.

◆ mutable_backgroundImageFile()

DriveBackgroundImageFile google_drive_api::Drive::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 shared drive is set. This is a write only field; it can only be set on drive.drives.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()

DriveCapabilities google_drive_api::Drive::mutable_capabilities ( )

inline

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

Capabilities the current user has on this shared drive.

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

◆ mutable_restrictions()

DriveRestrictions google_drive_api::Drive::mutable_restrictions ( )

inline

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

A set of restrictions that apply to this shared drive or items inside this shared drive.

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

◆ New()

Drive * google_drive_api::Drive::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_background_image_link()

void google_drive_api::Drive::set_background_image_link ( const StringPiece & value )

inline

Change the 'backgroundImageLink' attribute.

A short-lived link to this shared drive's background image.

Parameters

[in] value The new value.

◆ set_color_rgb()

void google_drive_api::Drive::set_color_rgb ( const StringPiece & value )

inline

Change the 'colorRgb' attribute.

The color of this shared drive as an RGB hex string. It can only be set on a drive.drives.update request that does not set themeId.

Parameters

[in] value The new value.

◆ set_created_date()

void google_drive_api::Drive::set_created_date ( client::DateTime value )

inline

Change the 'createdDate' attribute.

The time at which the shared drive was created (RFC 3339 date-time).

Parameters

[in] value The new value.

◆ set_hidden()

void google_drive_api::Drive::set_hidden ( bool value )

inline

Change the 'hidden' attribute.

Whether the shared drive is hidden from default view.

Parameters

[in] value The new value.

◆ set_id()

void google_drive_api::Drive::set_id ( const StringPiece & value )

inline

Change the 'id' attribute.

The ID of this shared drive which is also the ID of the top level folder of this shared drive.

Parameters

[in] value The new value.

◆ set_kind()

void google_drive_api::Drive::set_kind ( const StringPiece & value )

inline

Change the 'kind' attribute.

This is always drive::drive.

Parameters

[in] value The new value.

◆ set_name()

void google_drive_api::Drive::set_name ( const StringPiece & value )

inline

Change the 'name' attribute.

The name of this shared drive.

Parameters

[in] value The new value.

◆ set_theme_id()

void google_drive_api::Drive::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 driveThemes can be retrieved from a drive.about.get response. When not specified on a drive.drives.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] value The new value.

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

google/drive_api/drive.h
google/drive_api/drive.cc

Classes

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Drive() [1/2]

◆ Drive() [2/2]

◆ ~Drive()

Member Function Documentation

◆ clear_background_image_file()

◆ clear_background_image_link()

◆ clear_capabilities()

◆ clear_color_rgb()

◆ clear_created_date()

◆ clear_hidden()

◆ clear_id()

◆ clear_kind()

◆ clear_name()

◆ clear_restrictions()

◆ clear_theme_id()

◆ get_background_image_file()

◆ get_background_image_link()

◆ get_capabilities()

◆ get_color_rgb()

◆ get_created_date()

◆ get_hidden()

◆ get_id()

◆ get_kind()

◆ get_name()

◆ get_restrictions()

◆ get_theme_id()

◆ GetTypeName()

◆ has_background_image_file()

◆ has_background_image_link()

◆ has_capabilities()

◆ has_color_rgb()

◆ has_created_date()

◆ has_hidden()

◆ has_id()

◆ has_kind()

◆ has_name()

◆ has_restrictions()

◆ has_theme_id()

◆ mutable_backgroundImageFile()

◆ mutable_capabilities()

◆ mutable_restrictions()

◆ New()

◆ set_background_image_link()

◆ set_color_rgb()

◆ set_created_date()

◆ set_hidden()

◆ set_id()

◆ set_kind()

◆ set_name()

◆ set_theme_id()