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

#include <app.h>

Inheritance diagram for google_drive_api::App:

Classes

class  AppIcons
 

Public Member Functions

 App (const Json::Value &storage)
 
 App (Json::Value *storage)
 
virtual ~App ()
 
const StringPiece GetTypeName () const
 
bool has_authorized () const
 
void clear_authorized ()
 
bool get_authorized () const
 
void set_authorized (bool value)
 
bool has_create_in_folder_template () const
 
void clear_create_in_folder_template ()
 
const StringPiece get_create_in_folder_template () const
 
void set_create_in_folder_template (const StringPiece &value)
 
bool has_create_url () const
 
void clear_create_url ()
 
const StringPiece get_create_url () const
 
void set_create_url (const StringPiece &value)
 
bool has_has_drive_wide_scope () const
 
void clear_has_drive_wide_scope ()
 
bool get_has_drive_wide_scope () const
 
void set_has_drive_wide_scope (bool value)
 
bool has_icons () const
 
void clear_icons ()
 
const client::JsonCppArray< AppIconsget_icons () const
 
client::JsonCppArray< AppIconsmutable_icons ()
 
bool has_id () const
 
void clear_id ()
 
const StringPiece get_id () const
 
void set_id (const StringPiece &value)
 
bool has_installed () const
 
void clear_installed ()
 
bool get_installed () const
 
void set_installed (bool value)
 
bool has_kind () const
 
void clear_kind ()
 
const StringPiece get_kind () const
 
void set_kind (const StringPiece &value)
 
bool has_long_description () const
 
void clear_long_description ()
 
const StringPiece get_long_description () const
 
void set_long_description (const StringPiece &value)
 
bool has_name () const
 
void clear_name ()
 
const StringPiece get_name () const
 
void set_name (const StringPiece &value)
 
bool has_object_type () const
 
void clear_object_type ()
 
const StringPiece get_object_type () const
 
void set_object_type (const StringPiece &value)
 
bool has_open_url_template () const
 
void clear_open_url_template ()
 
const StringPiece get_open_url_template () const
 
void set_open_url_template (const StringPiece &value)
 
bool has_primary_file_extensions () const
 
void clear_primary_file_extensions ()
 
const client::JsonCppArray< string > get_primary_file_extensions () const
 
client::JsonCppArray< string > mutable_primaryFileExtensions ()
 
bool has_primary_mime_types () const
 
void clear_primary_mime_types ()
 
const client::JsonCppArray< string > get_primary_mime_types () const
 
client::JsonCppArray< string > mutable_primaryMimeTypes ()
 
bool has_product_id () const
 
void clear_product_id ()
 
const StringPiece get_product_id () const
 
void set_product_id (const StringPiece &value)
 
bool has_product_url () const
 
void clear_product_url ()
 
const StringPiece get_product_url () const
 
void set_product_url (const StringPiece &value)
 
bool has_secondary_file_extensions () const
 
void clear_secondary_file_extensions ()
 
const client::JsonCppArray< string > get_secondary_file_extensions () const
 
client::JsonCppArray< string > mutable_secondaryFileExtensions ()
 
bool has_secondary_mime_types () const
 
void clear_secondary_mime_types ()
 
const client::JsonCppArray< string > get_secondary_mime_types () const
 
client::JsonCppArray< string > mutable_secondaryMimeTypes ()
 
bool has_short_description () const
 
void clear_short_description ()
 
const StringPiece get_short_description () const
 
void set_short_description (const StringPiece &value)
 
bool has_supports_create () const
 
void clear_supports_create ()
 
bool get_supports_create () const
 
void set_supports_create (bool value)
 
bool has_supports_import () const
 
void clear_supports_import ()
 
bool get_supports_import () const
 
void set_supports_import (bool value)
 
bool has_supports_multi_open () const
 
void clear_supports_multi_open ()
 
bool get_supports_multi_open () const
 
void set_supports_multi_open (bool value)
 
bool has_supports_offline_create () const
 
void clear_supports_offline_create ()
 
bool get_supports_offline_create () const
 
void set_supports_offline_create (bool value)
 
bool has_use_by_default () const
 
void clear_use_by_default ()
 
bool get_use_by_default () const
 
void set_use_by_default (bool value)
 

Static Public Member Functions

static AppNew ()
 

Detailed Description

The apps resource provides a list of the apps that a user has installed, with information about each app's supported MIME types, file extensions, and other details.

Constructor & Destructor Documentation

◆ App() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ App() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~App()

google_drive_api::App::~App ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_authorized()

void google_drive_api::App::clear_authorized ( )
inline

Clears the 'authorized' attribute.

◆ clear_create_in_folder_template()

void google_drive_api::App::clear_create_in_folder_template ( )
inline

Clears the 'createInFolderTemplate' attribute.

◆ clear_create_url()

void google_drive_api::App::clear_create_url ( )
inline

Clears the 'createUrl' attribute.

◆ clear_has_drive_wide_scope()

void google_drive_api::App::clear_has_drive_wide_scope ( )
inline

Clears the 'hasDriveWideScope' attribute.

◆ clear_icons()

void google_drive_api::App::clear_icons ( )
inline

Clears the 'icons' attribute.

◆ clear_id()

void google_drive_api::App::clear_id ( )
inline

Clears the 'id' attribute.

◆ clear_installed()

void google_drive_api::App::clear_installed ( )
inline

Clears the 'installed' attribute.

◆ clear_kind()

void google_drive_api::App::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_long_description()

void google_drive_api::App::clear_long_description ( )
inline

Clears the 'longDescription' attribute.

◆ clear_name()

void google_drive_api::App::clear_name ( )
inline

Clears the 'name' attribute.

◆ clear_object_type()

void google_drive_api::App::clear_object_type ( )
inline

Clears the 'objectType' attribute.

◆ clear_open_url_template()

void google_drive_api::App::clear_open_url_template ( )
inline

Clears the 'openUrlTemplate' attribute.

◆ clear_primary_file_extensions()

void google_drive_api::App::clear_primary_file_extensions ( )
inline

Clears the 'primaryFileExtensions' attribute.

◆ clear_primary_mime_types()

void google_drive_api::App::clear_primary_mime_types ( )
inline

Clears the 'primaryMimeTypes' attribute.

◆ clear_product_id()

void google_drive_api::App::clear_product_id ( )
inline

Clears the 'productId' attribute.

◆ clear_product_url()

void google_drive_api::App::clear_product_url ( )
inline

Clears the 'productUrl' attribute.

◆ clear_secondary_file_extensions()

void google_drive_api::App::clear_secondary_file_extensions ( )
inline

Clears the 'secondaryFileExtensions' attribute.

◆ clear_secondary_mime_types()

void google_drive_api::App::clear_secondary_mime_types ( )
inline

Clears the 'secondaryMimeTypes' attribute.

◆ clear_short_description()

void google_drive_api::App::clear_short_description ( )
inline

Clears the 'shortDescription' attribute.

◆ clear_supports_create()

void google_drive_api::App::clear_supports_create ( )
inline

Clears the 'supportsCreate' attribute.

◆ clear_supports_import()

void google_drive_api::App::clear_supports_import ( )
inline

Clears the 'supportsImport' attribute.

◆ clear_supports_multi_open()

void google_drive_api::App::clear_supports_multi_open ( )
inline

Clears the 'supportsMultiOpen' attribute.

◆ clear_supports_offline_create()

void google_drive_api::App::clear_supports_offline_create ( )
inline

Clears the 'supportsOfflineCreate' attribute.

◆ clear_use_by_default()

void google_drive_api::App::clear_use_by_default ( )
inline

Clears the 'useByDefault' attribute.

◆ get_authorized()

bool google_drive_api::App::get_authorized ( ) const
inline

Get the value of the 'authorized' attribute.

◆ get_create_in_folder_template()

const StringPiece google_drive_api::App::get_create_in_folder_template ( ) const
inline

Get the value of the 'createInFolderTemplate' attribute.

◆ get_create_url()

const StringPiece google_drive_api::App::get_create_url ( ) const
inline

Get the value of the 'createUrl' attribute.

◆ get_has_drive_wide_scope()

bool google_drive_api::App::get_has_drive_wide_scope ( ) const
inline

Get the value of the 'hasDriveWideScope' attribute.

◆ get_icons()

const client::JsonCppArray<AppIcons > google_drive_api::App::get_icons ( ) const
inline

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

◆ get_id()

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

Get the value of the 'id' attribute.

◆ get_installed()

bool google_drive_api::App::get_installed ( ) const
inline

Get the value of the 'installed' attribute.

◆ get_kind()

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

Get the value of the 'kind' attribute.

◆ get_long_description()

const StringPiece google_drive_api::App::get_long_description ( ) const
inline

Get the value of the 'longDescription' attribute.

◆ get_name()

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

Get the value of the 'name' attribute.

◆ get_object_type()

const StringPiece google_drive_api::App::get_object_type ( ) const
inline

Get the value of the 'objectType' attribute.

◆ get_open_url_template()

const StringPiece google_drive_api::App::get_open_url_template ( ) const
inline

Get the value of the 'openUrlTemplate' attribute.

◆ get_primary_file_extensions()

const client::JsonCppArray<string > google_drive_api::App::get_primary_file_extensions ( ) const
inline

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

◆ get_primary_mime_types()

const client::JsonCppArray<string > google_drive_api::App::get_primary_mime_types ( ) const
inline

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

◆ get_product_id()

const StringPiece google_drive_api::App::get_product_id ( ) const
inline

Get the value of the 'productId' attribute.

◆ get_product_url()

const StringPiece google_drive_api::App::get_product_url ( ) const
inline

Get the value of the 'productUrl' attribute.

◆ get_secondary_file_extensions()

const client::JsonCppArray<string > google_drive_api::App::get_secondary_file_extensions ( ) const
inline

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

◆ get_secondary_mime_types()

const client::JsonCppArray<string > google_drive_api::App::get_secondary_mime_types ( ) const
inline

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

◆ get_short_description()

const StringPiece google_drive_api::App::get_short_description ( ) const
inline

Get the value of the 'shortDescription' attribute.

◆ get_supports_create()

bool google_drive_api::App::get_supports_create ( ) const
inline

Get the value of the 'supportsCreate' attribute.

◆ get_supports_import()

bool google_drive_api::App::get_supports_import ( ) const
inline

Get the value of the 'supportsImport' attribute.

◆ get_supports_multi_open()

bool google_drive_api::App::get_supports_multi_open ( ) const
inline

Get the value of the 'supportsMultiOpen' attribute.

◆ get_supports_offline_create()

bool google_drive_api::App::get_supports_offline_create ( ) const
inline

Get the value of the 'supportsOfflineCreate' attribute.

◆ get_use_by_default()

bool google_drive_api::App::get_use_by_default ( ) const
inline

Get the value of the 'useByDefault' attribute.

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_drive_api::App

◆ has_authorized()

bool google_drive_api::App::has_authorized ( ) const
inline

Determine if the 'authorized' attribute was set.

Returns
true if the 'authorized' attribute was set.

◆ has_create_in_folder_template()

bool google_drive_api::App::has_create_in_folder_template ( ) const
inline

Determine if the 'createInFolderTemplate' attribute was set.

Returns
true if the 'createInFolderTemplate' attribute was set.

◆ has_create_url()

bool google_drive_api::App::has_create_url ( ) const
inline

Determine if the 'createUrl' attribute was set.

Returns
true if the 'createUrl' attribute was set.

◆ has_has_drive_wide_scope()

bool google_drive_api::App::has_has_drive_wide_scope ( ) const
inline

Determine if the 'hasDriveWideScope' attribute was set.

Returns
true if the 'hasDriveWideScope' attribute was set.

◆ has_icons()

bool google_drive_api::App::has_icons ( ) const
inline

Determine if the 'icons' attribute was set.

Returns
true if the 'icons' attribute was set.

◆ has_id()

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

Determine if the 'id' attribute was set.

Returns
true if the 'id' attribute was set.

◆ has_installed()

bool google_drive_api::App::has_installed ( ) const
inline

Determine if the 'installed' attribute was set.

Returns
true if the 'installed' attribute was set.

◆ has_kind()

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

Determine if the 'kind' attribute was set.

Returns
true if the 'kind' attribute was set.

◆ has_long_description()

bool google_drive_api::App::has_long_description ( ) const
inline

Determine if the 'longDescription' attribute was set.

Returns
true if the 'longDescription' attribute was set.

◆ has_name()

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

Determine if the 'name' attribute was set.

Returns
true if the 'name' attribute was set.

◆ has_object_type()

bool google_drive_api::App::has_object_type ( ) const
inline

Determine if the 'objectType' attribute was set.

Returns
true if the 'objectType' attribute was set.

◆ has_open_url_template()

bool google_drive_api::App::has_open_url_template ( ) const
inline

Determine if the 'openUrlTemplate' attribute was set.

Returns
true if the 'openUrlTemplate' attribute was set.

◆ has_primary_file_extensions()

bool google_drive_api::App::has_primary_file_extensions ( ) const
inline

Determine if the 'primaryFileExtensions' attribute was set.

Returns
true if the 'primaryFileExtensions' attribute was set.

◆ has_primary_mime_types()

bool google_drive_api::App::has_primary_mime_types ( ) const
inline

Determine if the 'primaryMimeTypes' attribute was set.

Returns
true if the 'primaryMimeTypes' attribute was set.

◆ has_product_id()

bool google_drive_api::App::has_product_id ( ) const
inline

Determine if the 'productId' attribute was set.

Returns
true if the 'productId' attribute was set.

◆ has_product_url()

bool google_drive_api::App::has_product_url ( ) const
inline

Determine if the 'productUrl' attribute was set.

Returns
true if the 'productUrl' attribute was set.

◆ has_secondary_file_extensions()

bool google_drive_api::App::has_secondary_file_extensions ( ) const
inline

Determine if the 'secondaryFileExtensions' attribute was set.

Returns
true if the 'secondaryFileExtensions' attribute was set.

◆ has_secondary_mime_types()

bool google_drive_api::App::has_secondary_mime_types ( ) const
inline

Determine if the 'secondaryMimeTypes' attribute was set.

Returns
true if the 'secondaryMimeTypes' attribute was set.

◆ has_short_description()

bool google_drive_api::App::has_short_description ( ) const
inline

Determine if the 'shortDescription' attribute was set.

Returns
true if the 'shortDescription' attribute was set.

◆ has_supports_create()

bool google_drive_api::App::has_supports_create ( ) const
inline

Determine if the 'supportsCreate' attribute was set.

Returns
true if the 'supportsCreate' attribute was set.

◆ has_supports_import()

bool google_drive_api::App::has_supports_import ( ) const
inline

Determine if the 'supportsImport' attribute was set.

Returns
true if the 'supportsImport' attribute was set.

◆ has_supports_multi_open()

bool google_drive_api::App::has_supports_multi_open ( ) const
inline

Determine if the 'supportsMultiOpen' attribute was set.

Returns
true if the 'supportsMultiOpen' attribute was set.

◆ has_supports_offline_create()

bool google_drive_api::App::has_supports_offline_create ( ) const
inline

Determine if the 'supportsOfflineCreate' attribute was set.

Returns
true if the 'supportsOfflineCreate' attribute was set.

◆ has_use_by_default()

bool google_drive_api::App::has_use_by_default ( ) const
inline

Determine if the 'useByDefault' attribute was set.

Returns
true if the 'useByDefault' attribute was set.

◆ mutable_icons()

client::JsonCppArray<AppIcons > google_drive_api::App::mutable_icons ( )
inline

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

The various icons for the app.

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

◆ mutable_primaryFileExtensions()

client::JsonCppArray<string > google_drive_api::App::mutable_primaryFileExtensions ( )
inline

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

The list of primary file extensions.

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

◆ mutable_primaryMimeTypes()

client::JsonCppArray<string > google_drive_api::App::mutable_primaryMimeTypes ( )
inline

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

The list of primary mime types.

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

◆ mutable_secondaryFileExtensions()

client::JsonCppArray<string > google_drive_api::App::mutable_secondaryFileExtensions ( )
inline

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

The list of secondary file extensions.

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

◆ mutable_secondaryMimeTypes()

client::JsonCppArray<string > google_drive_api::App::mutable_secondaryMimeTypes ( )
inline

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

The list of secondary mime types.

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

◆ New()

App * google_drive_api::App::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_authorized()

void google_drive_api::App::set_authorized ( bool  value)
inline

Change the 'authorized' attribute.

Whether the app is authorized to access data on the user's Drive.

Parameters
[in]valueThe new value.

◆ set_create_in_folder_template()

void google_drive_api::App::set_create_in_folder_template ( const StringPiece &  value)
inline

Change the 'createInFolderTemplate' attribute.

The template url to create a new file with this app in a given folder. The template will contain {folderId} to be replaced by the folder to create the new file in.

Parameters
[in]valueThe new value.

◆ set_create_url()

void google_drive_api::App::set_create_url ( const StringPiece &  value)
inline

Change the 'createUrl' attribute.

The url to create a new file with this app.

Parameters
[in]valueThe new value.

◆ set_has_drive_wide_scope()

void google_drive_api::App::set_has_drive_wide_scope ( bool  value)
inline

Change the 'hasDriveWideScope' attribute.

Whether the app has drive-wide scope. An app with drive-wide scope can access all files in the user's drive.

Parameters
[in]valueThe new value.

◆ set_id()

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

Change the 'id' attribute.

The ID of the app.

Parameters
[in]valueThe new value.

◆ set_installed()

void google_drive_api::App::set_installed ( bool  value)
inline

Change the 'installed' attribute.

Whether the app is installed.

Parameters
[in]valueThe new value.

◆ set_kind()

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

Change the 'kind' attribute.

This is always drive::app.

Parameters
[in]valueThe new value.

◆ set_long_description()

void google_drive_api::App::set_long_description ( const StringPiece &  value)
inline

Change the 'longDescription' attribute.

A long description of the app.

Parameters
[in]valueThe new value.

◆ set_name()

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

Change the 'name' attribute.

The name of the app.

Parameters
[in]valueThe new value.

◆ set_object_type()

void google_drive_api::App::set_object_type ( const StringPiece &  value)
inline

Change the 'objectType' attribute.

The type of object this app creates (e.g. Chart). If empty, the app name should be used instead.

Parameters
[in]valueThe new value.

◆ set_open_url_template()

void google_drive_api::App::set_open_url_template ( const StringPiece &  value)
inline

Change the 'openUrlTemplate' attribute.

The template url for opening files with this app. The template will contain {ids} and/or {exportIds} to be replaced by the actual file ids. See Open Files for the full documentation.

Parameters
[in]valueThe new value.

◆ set_product_id()

void google_drive_api::App::set_product_id ( const StringPiece &  value)
inline

Change the 'productId' attribute.

The ID of the product listing for this app.

Parameters
[in]valueThe new value.

◆ set_product_url()

void google_drive_api::App::set_product_url ( const StringPiece &  value)
inline

Change the 'productUrl' attribute.

A link to the product listing for this app.

Parameters
[in]valueThe new value.

◆ set_short_description()

void google_drive_api::App::set_short_description ( const StringPiece &  value)
inline

Change the 'shortDescription' attribute.

A short description of the app.

Parameters
[in]valueThe new value.

◆ set_supports_create()

void google_drive_api::App::set_supports_create ( bool  value)
inline

Change the 'supportsCreate' attribute.

Whether this app supports creating new objects.

Parameters
[in]valueThe new value.

◆ set_supports_import()

void google_drive_api::App::set_supports_import ( bool  value)
inline

Change the 'supportsImport' attribute.

Whether this app supports importing Google Docs.

Parameters
[in]valueThe new value.

◆ set_supports_multi_open()

void google_drive_api::App::set_supports_multi_open ( bool  value)
inline

Change the 'supportsMultiOpen' attribute.

Whether this app supports opening more than one file.

Parameters
[in]valueThe new value.

◆ set_supports_offline_create()

void google_drive_api::App::set_supports_offline_create ( bool  value)
inline

Change the 'supportsOfflineCreate' attribute.

Whether this app supports creating new files when offline.

Parameters
[in]valueThe new value.

◆ set_use_by_default()

void google_drive_api::App::set_use_by_default ( bool  value)
inline

Change the 'useByDefault' attribute.

Whether the app is selected as the default handler for the types it supports.

Parameters
[in]valueThe new value.

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