#include <gmail_service.h>

Inheritance diagram for google_gmail_api::GmailServiceBaseRequest:

Public Member Functions
	GmailServiceBaseRequest (const client::ClientService service, client::AuthorizationCredential credential, client::HttpRequest::HttpMethod method, const StringPiece &uri_template)

virtual	~GmailServiceBaseRequest ()

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)

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

virtual util::Status	AppendOptionalQueryParameters (string *target)

Protected Member Functions
void	AddJsonContentToRequest (const client::JsonCppData *content)

Detailed Description

Implements a common base method for all methods within the GmailService.

This class defines all the attributes common across all methods. It does not pertain to any specific service API so is not normally explicitly instantiated.

Constructor & Destructor Documentation

◆ GmailServiceBaseRequest()

google_gmail_api::GmailServiceBaseRequest::GmailServiceBaseRequest	(	const client::ClientService *	service,
		client::AuthorizationCredential *	credential,
		client::HttpRequest::HttpMethod	method,
		const StringPiece &	uri_template
	)

Standard constructor.

Parameters

[in]	service	The service instance to send to when executed. In practice this will be supplied internally by the service when it acts as a method factory.
[in]	credential	If not NULL then the credential to authorize with. In practice this is supplied by the user code that is creating the method instance.
[in]	method	The HTTP method to use for the underlying HTTP request. In practice this is specified by the particular API endpoint and supplied internally by the derived class for that endpoint.
[in]	uri_template	The RFC 6570 URI Template specifying the url to invoke The parameters in the template should be resolvable attributes. In practice this parameter is supplied internally by the derived class for the endpoint.

◆ ~GmailServiceBaseRequest()

google_gmail_api::GmailServiceBaseRequest::~GmailServiceBaseRequest ( )

virtual

Standard destructor.

Member Function Documentation

◆ AddJsonContentToRequest()

void google_gmail_api::GmailServiceBaseRequest::AddJsonContentToRequest ( const client::JsonCppData * content )

protected

Prepares the method's HTTP request to send body content as JSON.

Only to be used for method constructors.

◆ AppendOptionalQueryParameters()

util::Status google_gmail_api::GmailServiceBaseRequest::AppendOptionalQueryParameters ( string * target )

virtual

Appends the optional query parameters to the target URL.

Parameters

[in,out] target The URL string to append to.

Reimplemented in google_gmail_api::UsersResource_ThreadsResource_ListMethod, google_gmail_api::UsersResource_ThreadsResource_GetMethod, google_gmail_api::UsersResource_MessagesResource_ListMethod, google_gmail_api::UsersResource_MessagesResource_InsertMethod, google_gmail_api::UsersResource_MessagesResource_ImportMethod, google_gmail_api::UsersResource_MessagesResource_GetMethod, google_gmail_api::UsersResource_HistoryResource_ListMethod, google_gmail_api::UsersResource_DraftsResource_ListMethod, and google_gmail_api::UsersResource_DraftsResource_GetMethod.

◆ AppendVariable()

util::Status google_gmail_api::GmailServiceBaseRequest::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 supplied to the constructor.

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.

◆ clear_alt()

void google_gmail_api::GmailServiceBaseRequest::clear_alt ( )

inline

Clears the 'alt' attribute so it is no longer set.

◆ clear_fields()

void google_gmail_api::GmailServiceBaseRequest::clear_fields ( )

inline

Clears the 'fields' attribute so it is no longer set.

◆ clear_key()

void google_gmail_api::GmailServiceBaseRequest::clear_key ( )

inline

Clears the 'key' attribute so it is no longer set.

◆ clear_oauth_token()

void google_gmail_api::GmailServiceBaseRequest::clear_oauth_token ( )

inline

Clears the 'oauth_token' attribute so it is no longer set.

◆ clear_pretty_print()

void google_gmail_api::GmailServiceBaseRequest::clear_pretty_print ( )

inline

Clears the 'prettyPrint' attribute so it is no longer set.

◆ clear_quota_user()

void google_gmail_api::GmailServiceBaseRequest::clear_quota_user ( )

inline

Clears the 'quotaUser' attribute so it is no longer set.

◆ clear_user_ip()

void google_gmail_api::GmailServiceBaseRequest::clear_user_ip ( )

inline

Clears the 'userIp' attribute so it is no longer set.