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

#include <books_service.h>

Inheritance diagram for google_books_api::FamilysharingResource_ShareMethod:
google_books_api::BooksServiceBaseRequest

Public Member Functions

 FamilysharingResource_ShareMethod (const BooksService *_service_, client::AuthorizationCredential *_credential_)
 
virtual ~FamilysharingResource_ShareMethod ()
 
void clear_doc_id ()
 
const string & get_doc_id () const
 
string * mutable_docId ()
 
void set_doc_id (const string &value)
 
void clear_source ()
 
const string & get_source () const
 
string * mutable_source ()
 
void set_source (const string &value)
 
void clear_volume_id ()
 
const string & get_volume_id () const
 
string * mutable_volumeId ()
 
void set_volume_id (const string &value)
 
virtual util::Status AppendVariable (const StringPiece &variable_name, const client::UriTemplateConfig &config, string *target)
 
virtual util::Status AppendOptionalQueryParameters (string *target)
 
- 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 share 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

◆ FamilysharingResource_ShareMethod()

google_books_api::FamilysharingResource_ShareMethod::FamilysharingResource_ShareMethod ( const BooksService _service_,
client::AuthorizationCredential *  _credential_ 
)

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.

◆ ~FamilysharingResource_ShareMethod()

google_books_api::FamilysharingResource_ShareMethod::~FamilysharingResource_ShareMethod ( )
virtual

Standard destructor.

Member Function Documentation

◆ AppendOptionalQueryParameters()

util::Status google_books_api::FamilysharingResource_ShareMethod::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::FamilysharingResource_ShareMethod::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_doc_id()

void google_books_api::FamilysharingResource_ShareMethod::clear_doc_id ( )
inline

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

◆ clear_source()

void google_books_api::FamilysharingResource_ShareMethod::clear_source ( )
inline

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

◆ clear_volume_id()

void google_books_api::FamilysharingResource_ShareMethod::clear_volume_id ( )
inline

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

◆ get_doc_id()

const string& google_books_api::FamilysharingResource_ShareMethod::get_doc_id ( ) const
inline

Gets the optional 'docId' attribute.

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

◆ get_source()

const string& google_books_api::FamilysharingResource_ShareMethod::get_source ( ) const
inline

Gets the optional 'source' attribute.

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

◆ get_volume_id()

const string& google_books_api::FamilysharingResource_ShareMethod::get_volume_id ( ) const
inline

Gets the optional 'volumeId' attribute.

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

◆ mutable_docId()

string* google_books_api::FamilysharingResource_ShareMethod::mutable_docId ( )
inline

Gets a modifiable pointer to the optional docId' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ mutable_source()

string* google_books_api::FamilysharingResource_ShareMethod::mutable_source ( )
inline

Gets a modifiable pointer to the optional source' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ mutable_volumeId()

string* google_books_api::FamilysharingResource_ShareMethod::mutable_volumeId ( )
inline

Gets a modifiable pointer to the optional volumeId' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ set_doc_id()

void google_books_api::FamilysharingResource_ShareMethod::set_doc_id ( const string &  value)
inline

Sets the 'docId' attribute.

Parameters
[in]valueThe docid to share.

◆ set_source()

void google_books_api::FamilysharingResource_ShareMethod::set_source ( const string &  value)
inline

Sets the 'source' attribute.

Parameters
[in]valueString to identify the originator of this request.

◆ set_volume_id()

void google_books_api::FamilysharingResource_ShareMethod::set_volume_id ( const string &  value)
inline

Sets the 'volumeId' attribute.

Parameters
[in]valueThe volume to share.

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