books  v1
Public Member Functions | List of all members
google_books_api::MyconfigResource_SyncVolumeLicensesMethod Class Reference

#include <books_service.h>

Inheritance diagram for google_books_api::MyconfigResource_SyncVolumeLicensesMethod:
google_books_api::BooksServiceBaseRequest

Public Member Functions

 MyconfigResource_SyncVolumeLicensesMethod (const BooksService *_service_, client::AuthorizationCredential *_credential_, const absl::string_view &source, const absl::string_view &nonce, const absl::string_view &cpksver)
 
virtual ~MyconfigResource_SyncVolumeLicensesMethod ()
 
void clear_features ()
 
const client::JsonCppArray< string > & get_features () const
 
client::JsonCppArray< string > * mutable_features ()
 
void clear_include_non_comics_series ()
 
bool get_include_non_comics_series () const
 
void set_include_non_comics_series (bool value)
 
void clear_locale ()
 
const string & get_locale () const
 
string * mutable_locale ()
 
void set_locale (const string &value)
 
void clear_show_preorders ()
 
bool get_show_preorders () const
 
void set_show_preorders (bool value)
 
void clear_volume_ids ()
 
const client::JsonCppArray< string > & get_volume_ids () const
 
client::JsonCppArray< string > * mutable_volumeIds ()
 
virtual util::Status AppendVariable (const StringPiece &variable_name, const client::UriTemplateConfig &config, string *target)
 
virtual util::Status AppendOptionalQueryParameters (string *target)
 
util::Status ExecuteAndParseResponse (Volumes *data)
 
- Public Member Functions inherited from google_books_api::BooksServiceBaseRequest
 BooksServiceBaseRequest (const client::ClientService *service, client::AuthorizationCredential *credential, client::HttpRequest::HttpMethod method, const StringPiece &uri_template)
 
virtual ~BooksServiceBaseRequest ()
 
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_books_api::BooksServiceBaseRequest
void AddJsonContentToRequest (const client::JsonCppData *content)
 

Detailed Description

Implements the syncVolumeLicenses 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/books

Constructor & Destructor Documentation

◆ MyconfigResource_SyncVolumeLicensesMethod()

google_books_api::MyconfigResource_SyncVolumeLicensesMethod::MyconfigResource_SyncVolumeLicensesMethod ( const BooksService _service_,
client::AuthorizationCredential *  _credential_,
const absl::string_view &  source,
const absl::string_view &  nonce,
const absl::string_view &  cpksver 
)

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]sourceString to identify the originator of this request.
[in]nonceThe client nonce value.
[in]cpksverThe device/version ID from which to release the restriction.

◆ ~MyconfigResource_SyncVolumeLicensesMethod()

google_books_api::MyconfigResource_SyncVolumeLicensesMethod::~MyconfigResource_SyncVolumeLicensesMethod ( )
virtual

Standard destructor.

Member Function Documentation

◆ AppendOptionalQueryParameters()

util::Status google_books_api::MyconfigResource_SyncVolumeLicensesMethod::AppendOptionalQueryParameters ( string *  target)
virtual

Appends the optional query parameters to the target URL.

Parameters
[in,out]targetThe URL string to append to.

Reimplemented from google_books_api::BooksServiceBaseRequest.

◆ AppendVariable()

util::Status google_books_api::MyconfigResource_SyncVolumeLicensesMethod::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_nameThe name of the templated variable.
[in]configA pass-through parameter used for lists and maps.
[in,out]targetThe string to append the value to.

Reimplemented from google_books_api::BooksServiceBaseRequest.

◆ clear_features()

void google_books_api::MyconfigResource_SyncVolumeLicensesMethod::clear_features ( )
inline

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

◆ clear_include_non_comics_series()

void google_books_api::MyconfigResource_SyncVolumeLicensesMethod::clear_include_non_comics_series ( )
inline

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

◆ clear_locale()

void google_books_api::MyconfigResource_SyncVolumeLicensesMethod::clear_locale ( )
inline

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

◆ clear_show_preorders()

void google_books_api::MyconfigResource_SyncVolumeLicensesMethod::clear_show_preorders ( )
inline

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

◆ clear_volume_ids()

void google_books_api::MyconfigResource_SyncVolumeLicensesMethod::clear_volume_ids ( )
inline

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

◆ ExecuteAndParseResponse()

util::Status google_books_api::MyconfigResource_SyncVolumeLicensesMethod::ExecuteAndParseResponse ( Volumes data)
inline

Executes the method and parses the response into a data object on success.

Parameters
[out]dataLoads from the response payload JSON data on success.
Returns
Success if an HTTP 2xx response was received. Otherwise the status indicates the reason for failure. Finer detail may be available from the underlying http_request to distinguish the transport_status from the overal HTTP request status.

◆ get_features()

const client::JsonCppArray<string >& google_books_api::MyconfigResource_SyncVolumeLicensesMethod::get_features ( ) const
inline

Gets the optional 'features' attribute.

If the value is not set then the default value will be returned.

◆ get_include_non_comics_series()

bool google_books_api::MyconfigResource_SyncVolumeLicensesMethod::get_include_non_comics_series ( ) const
inline

Gets the optional 'includeNonComicsSeries' attribute.

If the value is not set then the default value will be returned.

◆ get_locale()

const string& google_books_api::MyconfigResource_SyncVolumeLicensesMethod::get_locale ( ) const
inline

Gets the optional 'locale' attribute.

If the value is not set then the default value will be returned.

◆ get_show_preorders()

bool google_books_api::MyconfigResource_SyncVolumeLicensesMethod::get_show_preorders ( ) const
inline

Gets the optional 'showPreorders' attribute.

If the value is not set then the default value will be returned.

◆ get_volume_ids()

const client::JsonCppArray<string >& google_books_api::MyconfigResource_SyncVolumeLicensesMethod::get_volume_ids ( ) const
inline

Gets the optional 'volumeIds' attribute.

If the value is not set then the default value will be returned.

◆ mutable_features()

client::JsonCppArray<string >* google_books_api::MyconfigResource_SyncVolumeLicensesMethod::mutable_features ( )
inline

Gets a modifiable pointer to the optional features' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ mutable_locale()

string* google_books_api::MyconfigResource_SyncVolumeLicensesMethod::mutable_locale ( )
inline

Gets a modifiable pointer to the optional locale' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ mutable_volumeIds()

client::JsonCppArray<string >* google_books_api::MyconfigResource_SyncVolumeLicensesMethod::mutable_volumeIds ( )
inline

Gets a modifiable pointer to the optional volumeIds' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ set_include_non_comics_series()

void google_books_api::MyconfigResource_SyncVolumeLicensesMethod::set_include_non_comics_series ( bool  value)
inline

Sets the 'includeNonComicsSeries' attribute.

Parameters
[in]valueSet to true to include non-comics series. Defaults to false.

◆ set_locale()

void google_books_api::MyconfigResource_SyncVolumeLicensesMethod::set_locale ( const string &  value)
inline

Sets the 'locale' attribute.

Parameters
[in]valueISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.

◆ set_show_preorders()

void google_books_api::MyconfigResource_SyncVolumeLicensesMethod::set_show_preorders ( bool  value)
inline

Sets the 'showPreorders' attribute.

Parameters
[in]valueSet to true to show pre-ordered books. Defaults to false.

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