#include <oauth2_service.h>
Implements a common base method for all methods within the Oauth2Service.
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.
◆ Oauth2ServiceBaseRequest()
google_oauth2_api::Oauth2ServiceBaseRequest::Oauth2ServiceBaseRequest |
( |
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. |
◆ ~Oauth2ServiceBaseRequest()
google_oauth2_api::Oauth2ServiceBaseRequest::~Oauth2ServiceBaseRequest |
( |
| ) |
|
|
virtual |
◆ AddJsonContentToRequest()
void google_oauth2_api::Oauth2ServiceBaseRequest::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_oauth2_api::Oauth2ServiceBaseRequest::AppendOptionalQueryParameters |
( |
string * |
target | ) |
|
|
virtual |
◆ AppendVariable()
util::Status google_oauth2_api::Oauth2ServiceBaseRequest::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. |
Reimplemented in google_oauth2_api::TokeninfoMethod.
◆ clear_alt()
void google_oauth2_api::Oauth2ServiceBaseRequest::clear_alt |
( |
| ) |
|
|
inline |
Clears the 'alt
' attribute so it is no longer set.
◆ clear_fields()
void google_oauth2_api::Oauth2ServiceBaseRequest::clear_fields |
( |
| ) |
|
|
inline |
Clears the 'fields
' attribute so it is no longer set.
◆ clear_key()
void google_oauth2_api::Oauth2ServiceBaseRequest::clear_key |
( |
| ) |
|
|
inline |
Clears the 'key
' attribute so it is no longer set.
◆ clear_oauth_token()
void google_oauth2_api::Oauth2ServiceBaseRequest::clear_oauth_token |
( |
| ) |
|
|
inline |
Clears the 'oauth_token
' attribute so it is no longer set.
◆ clear_pretty_print()
void google_oauth2_api::Oauth2ServiceBaseRequest::clear_pretty_print |
( |
| ) |
|
|
inline |
Clears the 'prettyPrint
' attribute so it is no longer set.
◆ clear_quota_user()
void google_oauth2_api::Oauth2ServiceBaseRequest::clear_quota_user |
( |
| ) |
|
|
inline |
Clears the 'quotaUser
' attribute so it is no longer set.
◆ clear_user_ip()
void google_oauth2_api::Oauth2ServiceBaseRequest::clear_user_ip |
( |
| ) |
|
|
inline |
Clears the 'userIp
' attribute so it is no longer set.
◆ get_alt()
const string& google_oauth2_api::Oauth2ServiceBaseRequest::get_alt |
( |
| ) |
const |
|
inline |
Gets the optional 'alt
' attribute.
If the value is not set then the default value will be returned.
◆ get_fields()
const string& google_oauth2_api::Oauth2ServiceBaseRequest::get_fields |
( |
| ) |
const |
|
inline |
Gets the optional 'fields
' attribute.
If the value is not set then the default value will be returned.
◆ get_key()
const string& google_oauth2_api::Oauth2ServiceBaseRequest::get_key |
( |
| ) |
const |
|
inline |
Gets the optional 'key
' attribute.
If the value is not set then the default value will be returned.
◆ get_oauth_token()
const string& google_oauth2_api::Oauth2ServiceBaseRequest::get_oauth_token |
( |
| ) |
const |
|
inline |
Gets the optional 'oauth_token
' attribute.
If the value is not set then the default value will be returned.
◆ get_pretty_print()
bool google_oauth2_api::Oauth2ServiceBaseRequest::get_pretty_print |
( |
| ) |
const |
|
inline |
Gets the optional 'prettyPrint
' attribute.
If the value is not set then the default value will be returned.
◆ get_quota_user()
const string& google_oauth2_api::Oauth2ServiceBaseRequest::get_quota_user |
( |
| ) |
const |
|
inline |
Gets the optional 'quotaUser
' attribute.
If the value is not set then the default value will be returned.
◆ get_user_ip()
const string& google_oauth2_api::Oauth2ServiceBaseRequest::get_user_ip |
( |
| ) |
const |
|
inline |
Gets the optional 'userIp
' attribute.
If the value is not set then the default value will be returned.
◆ mutable_alt()
string* google_oauth2_api::Oauth2ServiceBaseRequest::mutable_alt |
( |
| ) |
|
|
inline |
Gets a modifiable pointer to the optional alt
' attribute.
- Returns
- The value can be set by dereferencing the pointer.
◆ mutable_fields()
string* google_oauth2_api::Oauth2ServiceBaseRequest::mutable_fields |
( |
| ) |
|
|
inline |
Gets a modifiable pointer to the optional fields
' attribute.
- Returns
- The value can be set by dereferencing the pointer.
◆ mutable_key()
string* google_oauth2_api::Oauth2ServiceBaseRequest::mutable_key |
( |
| ) |
|
|
inline |
Gets a modifiable pointer to the optional key
' attribute.
- Returns
- The value can be set by dereferencing the pointer.
◆ mutable_oauthToken()
string* google_oauth2_api::Oauth2ServiceBaseRequest::mutable_oauthToken |
( |
| ) |
|
|
inline |
Gets a modifiable pointer to the optional oauth_token
' attribute.
- Returns
- The value can be set by dereferencing the pointer.
◆ mutable_quotaUser()
string* google_oauth2_api::Oauth2ServiceBaseRequest::mutable_quotaUser |
( |
| ) |
|
|
inline |
Gets a modifiable pointer to the optional quotaUser
' attribute.
- Returns
- The value can be set by dereferencing the pointer.
◆ mutable_userIp()
string* google_oauth2_api::Oauth2ServiceBaseRequest::mutable_userIp |
( |
| ) |
|
|
inline |
Gets a modifiable pointer to the optional userIp
' attribute.
- Returns
- The value can be set by dereferencing the pointer.
◆ set_alt()
void google_oauth2_api::Oauth2ServiceBaseRequest::set_alt |
( |
const string & |
value | ) |
|
|
inline |
Sets the 'alt
' attribute.
- Parameters
-
[in] | value | Data format for the response. |
◆ set_fields()
void google_oauth2_api::Oauth2ServiceBaseRequest::set_fields |
( |
const string & |
value | ) |
|
|
inline |
Sets the 'fields
' attribute.
- Parameters
-
[in] | value | Selector specifying which fields to include in a partial response. |
◆ set_key()
void google_oauth2_api::Oauth2ServiceBaseRequest::set_key |
( |
const string & |
value | ) |
|
|
inline |
Sets the 'key
' attribute.
- Parameters
-
[in] | value | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
◆ set_oauth_token()
void google_oauth2_api::Oauth2ServiceBaseRequest::set_oauth_token |
( |
const string & |
value | ) |
|
|
inline |
Sets the 'oauth_token
' attribute.
- Parameters
-
[in] | value | OAuth 2.0 token for the current user. |
◆ set_pretty_print()
void google_oauth2_api::Oauth2ServiceBaseRequest::set_pretty_print |
( |
bool |
value | ) |
|
|
inline |
Sets the 'prettyPrint
' attribute.
- Parameters
-
[in] | value | Returns response with indentations and line breaks. |
◆ set_quota_user()
void google_oauth2_api::Oauth2ServiceBaseRequest::set_quota_user |
( |
const string & |
value | ) |
|
|
inline |
Sets the 'quotaUser
' attribute.
- Parameters
-
[in] | value | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
◆ set_user_ip()
void google_oauth2_api::Oauth2ServiceBaseRequest::set_user_ip |
( |
const string & |
value | ) |
|
|
inline |
Sets the 'userIp
' attribute.
- Deprecated:
- Parameters
-
[in] | value | Deprecated. Please use quotaUser instead. |
The documentation for this class was generated from the following files: