drive  v2
Public Member Functions | Static Public Member Functions | List of all members
google_drive_api::Drive::DriveBackgroundImageFile Class Reference
Drive API Data Objects

#include <drive.h>

Inheritance diagram for google_drive_api::Drive::DriveBackgroundImageFile:

Public Member Functions

 DriveBackgroundImageFile (const Json::Value &storage)
 
 DriveBackgroundImageFile (Json::Value *storage)
 
virtual ~DriveBackgroundImageFile ()
 
const StringPiece GetTypeName () const
 
bool has_id () const
 
void clear_id ()
 
const StringPiece get_id () const
 
void set_id (const StringPiece &value)
 
bool has_width () const
 
void clear_width ()
 
float get_width () const
 
void set_width (float value)
 
bool has_x_coordinate () const
 
void clear_x_coordinate ()
 
float get_x_coordinate () const
 
void set_x_coordinate (float value)
 
bool has_y_coordinate () const
 
void clear_y_coordinate ()
 
float get_y_coordinate () const
 
void set_y_coordinate (float value)
 

Static Public Member Functions

static DriveBackgroundImageFile * New ()
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ DriveBackgroundImageFile() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ DriveBackgroundImageFile() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~DriveBackgroundImageFile()

google_drive_api::Drive::DriveBackgroundImageFile::~DriveBackgroundImageFile ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_id()

void google_drive_api::Drive::DriveBackgroundImageFile::clear_id ( )
inline

Clears the 'id' attribute.

◆ clear_width()

void google_drive_api::Drive::DriveBackgroundImageFile::clear_width ( )
inline

Clears the 'width' attribute.

◆ clear_x_coordinate()

void google_drive_api::Drive::DriveBackgroundImageFile::clear_x_coordinate ( )
inline

Clears the 'xCoordinate' attribute.

◆ clear_y_coordinate()

void google_drive_api::Drive::DriveBackgroundImageFile::clear_y_coordinate ( )
inline

Clears the 'yCoordinate' attribute.

◆ get_id()

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

Get the value of the 'id' attribute.

◆ get_width()

float google_drive_api::Drive::DriveBackgroundImageFile::get_width ( ) const
inline

Get the value of the 'width' attribute.

◆ get_x_coordinate()

float google_drive_api::Drive::DriveBackgroundImageFile::get_x_coordinate ( ) const
inline

Get the value of the 'xCoordinate' attribute.

◆ get_y_coordinate()

float google_drive_api::Drive::DriveBackgroundImageFile::get_y_coordinate ( ) const
inline

Get the value of the 'yCoordinate' attribute.

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_drive_api::DriveBackgroundImageFile

◆ has_id()

bool google_drive_api::Drive::DriveBackgroundImageFile::has_id ( ) const
inline

Determine if the 'id' attribute was set.

Returns
true if the 'id' attribute was set.

◆ has_width()

bool google_drive_api::Drive::DriveBackgroundImageFile::has_width ( ) const
inline

Determine if the 'width' attribute was set.

Returns
true if the 'width' attribute was set.

◆ has_x_coordinate()

bool google_drive_api::Drive::DriveBackgroundImageFile::has_x_coordinate ( ) const
inline

Determine if the 'xCoordinate' attribute was set.

Returns
true if the 'xCoordinate' attribute was set.

◆ has_y_coordinate()

bool google_drive_api::Drive::DriveBackgroundImageFile::has_y_coordinate ( ) const
inline

Determine if the 'yCoordinate' attribute was set.

Returns
true if the 'yCoordinate' attribute was set.

◆ New()

Drive::DriveBackgroundImageFile * google_drive_api::Drive::DriveBackgroundImageFile::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_id()

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

Change the 'id' attribute.

The ID of an image file in Google Drive to use for the background image.

Parameters
[in]valueThe new value.

◆ set_width()

void google_drive_api::Drive::DriveBackgroundImageFile::set_width ( float  value)
inline

Change the 'width' attribute.

The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.

Parameters
[in]valueThe new value.

◆ set_x_coordinate()

void google_drive_api::Drive::DriveBackgroundImageFile::set_x_coordinate ( float  value)
inline

Change the 'xCoordinate' attribute.

The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.

Parameters
[in]valueThe new value.

◆ set_y_coordinate()

void google_drive_api::Drive::DriveBackgroundImageFile::set_y_coordinate ( float  value)
inline

Change the 'yCoordinate' attribute.

The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.

Parameters
[in]valueThe new value.
The documentation for this class was generated from the following files: