google_drive_api::FilesResource_ExportMethod Class Reference

#include <drive_service.h>

Inheritance diagram for google_drive_api::FilesResource_ExportMethod:

Public Member Functions
	FilesResource_ExportMethod (const DriveService *_service_, client::AuthorizationCredential *_credential_, const absl::string_view &file_id, const absl::string_view &mime_type)
virtual	~FilesResource_ExportMethod ()
virtual util::Status	AppendVariable (const StringPiece &variable_name, const client::UriTemplateConfig &config, string *target)
virtual util::Status	AppendOptionalQueryParameters (string *target)
bool	get_use_media_download () const
void	set_use_media_download (bool use)
Public Member Functions inherited from google_drive_api::DriveServiceBaseRequest
	DriveServiceBaseRequest (const client::ClientService *service, client::AuthorizationCredential *credential, client::HttpRequest::HttpMethod method, const StringPiece &uri_template)
virtual	~DriveServiceBaseRequest ()
void	clear_alt ()
const string &	get_alt () const
string *	mutable_alt ()
void	set_alt (const string &value)
void	clear_fields ()
const string &	get_fields () const
string *	mutable_fields ()
void	set_fields (const string &value)
void	clear_key ()
const string &	get_key () const
string *	mutable_key ()
void	set_key (const string &value)
void	clear_oauth_token ()
const string &	get_oauth_token () const
string *	mutable_oauthToken ()
void	set_oauth_token (const string &value)
void	clear_pretty_print ()
bool	get_pretty_print () const
void	set_pretty_print (bool value)
void	clear_quota_user ()
const string &	get_quota_user () const
string *	mutable_quotaUser ()
void	set_quota_user (const string &value)
void	clear_user_ip ()
const string &	get_user_ip () const
string *	mutable_userIp ()
void	set_user_ip (const string &value)

Additional Inherited Members
Protected Member Functions inherited from google_drive_api::DriveServiceBaseRequest
void	AddJsonContentToRequest (const client::JsonCppData *content)

Detailed Description

Implements the export method.

This class uses the Command Pattern. Construct an instance with the required parameters, then set any additional optional parameters by using the attribute setters. To invoke the method, call Execute.

One or more of these authorization scopes are required for this method: https://www.googleapis.com/auth/drive https://www.googleapis.com/auth/drive.file https://www.googleapis.com/auth/drive.readonly

Constructor & Destructor Documentation

FilesResource_ExportMethod()

google_drive_api::FilesResource_ExportMethod::FilesResource_ExportMethod	(	const DriveService *	_service_,
		client::AuthorizationCredential *	_credential_,
		const absl::string_view &	file_id,
		const absl::string_view &	mime_type
	)

The standard constructor takes all the required method parameters.

Parameters

[in]	<em>service</em>	The service instance to send to when executed.
[in]	<em>credential</em>	If not NULL, the credential to authorize with. In practice this is supplied by the user code that is creating the method instance.
[in]	file_id	The ID of the file.
[in]	mime_type	The MIME type of the format requested for this export.

~FilesResource_ExportMethod()

google_drive_api::FilesResource_ExportMethod::~FilesResource_ExportMethod ( )

virtual

Standard destructor.

Member Function Documentation

AppendOptionalQueryParameters()

util::Status google_drive_api::FilesResource_ExportMethod::AppendOptionalQueryParameters ( string *  target )

virtual

Appends the optional query parameters to the target URL.

Parameters

[in,out]

target

The URL string to append to.

Reimplemented from google_drive_api::DriveServiceBaseRequest.

AppendVariable()

util::Status google_drive_api::FilesResource_ExportMethod::AppendVariable ( const StringPiece &  variable_name, const client::UriTemplateConfig &  config, string *  target  )

virtual

Appends variable value to the target string.

This is a helper function used to resolve templated variables in the URI.

Parameters

[in]	variable_name	The name of the templated variable.
[in]	config	A pass-through parameter used for lists and maps.
[in,out]	target	The string to append the value to.

Reimplemented from google_drive_api::DriveServiceBaseRequest.

get_use_media_download()

bool google_drive_api::FilesResource_ExportMethod::get_use_media_download ( ) const

inline

Determine if the request should use Media Download for the response.

Returns

true for media download, false otherwise.

set_use_media_download()

void google_drive_api::FilesResource_ExportMethod::set_use_media_download ( bool  use )

inline

Sets whether Media Download should be used for the response data.

Parameters

[in]

use

true to use media download, false otherwise.

---

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

• google/drive_api/drive_service.h
• google/drive_api/drive_service.cc