#include <civic_info_service.h>

Inheritance diagram for google_civicinfo_api::RepresentativesResource_RepresentativeInfoByAddressMethod:

Public Member Functions
	RepresentativesResource_RepresentativeInfoByAddressMethod (const CivicInfoService _service_, client::AuthorizationCredential _credential_)

virtual	~RepresentativesResource_RepresentativeInfoByAddressMethod ()

void	clear_address ()

const string &	get_address () const

string *	mutable_address ()

void	set_address (const string &value)

void	clear_include_offices ()

bool	get_include_offices () const

void	set_include_offices (bool value)

void	clear_levels ()

const client::JsonCppArray< string > &	get_levels () const

client::JsonCppArray< string > *	mutable_levels ()

void	clear_roles ()

const client::JsonCppArray< string > &	get_roles () const

client::JsonCppArray< string > *	mutable_roles ()

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

virtual util::Status	AppendOptionalQueryParameters (string *target)

util::Status	ExecuteAndParseResponse (RepresentativeInfoResponse *data)

Public Member Functions inherited from google_civicinfo_api::CivicInfoServiceBaseRequest
	CivicInfoServiceBaseRequest (const client::ClientService service, client::AuthorizationCredential credential, client::HttpRequest::HttpMethod method, const StringPiece &uri_template)

virtual	~CivicInfoServiceBaseRequest ()

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_civicinfo_api::CivicInfoServiceBaseRequest
void	AddJsonContentToRequest (const client::JsonCppData *content)

Detailed Description

Implements the representativeInfoByAddress 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.

No authorization scopes are required for this method.

Constructor & Destructor Documentation

◆ RepresentativesResource_RepresentativeInfoByAddressMethod()

google_civicinfo_api::RepresentativesResource_RepresentativeInfoByAddressMethod::RepresentativesResource_RepresentativeInfoByAddressMethod	(	const CivicInfoService *	_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.

◆ ~RepresentativesResource_RepresentativeInfoByAddressMethod()

google_civicinfo_api::RepresentativesResource_RepresentativeInfoByAddressMethod::~RepresentativesResource_RepresentativeInfoByAddressMethod ( )

virtual

Standard destructor.

Member Function Documentation

◆ AppendOptionalQueryParameters()

util::Status google_civicinfo_api::RepresentativesResource_RepresentativeInfoByAddressMethod::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_civicinfo_api::CivicInfoServiceBaseRequest.

◆ AppendVariable()

util::Status google_civicinfo_api::RepresentativesResource_RepresentativeInfoByAddressMethod::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_civicinfo_api::CivicInfoServiceBaseRequest.

◆ clear_address()

void google_civicinfo_api::RepresentativesResource_RepresentativeInfoByAddressMethod::clear_address ( )

inline

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

◆ clear_include_offices()

void google_civicinfo_api::RepresentativesResource_RepresentativeInfoByAddressMethod::clear_include_offices ( )

inline

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

◆ clear_levels()

void google_civicinfo_api::RepresentativesResource_RepresentativeInfoByAddressMethod::clear_levels ( )

inline

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

◆ clear_roles()

void google_civicinfo_api::RepresentativesResource_RepresentativeInfoByAddressMethod::clear_roles ( )

inline

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

◆ ExecuteAndParseResponse()

util::Status google_civicinfo_api::RepresentativesResource_RepresentativeInfoByAddressMethod::ExecuteAndParseResponse ( RepresentativeInfoResponse * data )

inline

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

Parameters

[out] data Loads 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_address()

const string& google_civicinfo_api::RepresentativesResource_RepresentativeInfoByAddressMethod::get_address ( ) const

inline

Gets the optional 'address' attribute.

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

◆ get_include_offices()

bool google_civicinfo_api::RepresentativesResource_RepresentativeInfoByAddressMethod::get_include_offices ( ) const

inline

Gets the optional 'includeOffices' attribute.

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

◆ get_levels()

const client::JsonCppArray<string >& google_civicinfo_api::RepresentativesResource_RepresentativeInfoByAddressMethod::get_levels ( ) const

inline

Gets the optional 'levels' attribute.

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

◆ get_roles()

const client::JsonCppArray<string >& google_civicinfo_api::RepresentativesResource_RepresentativeInfoByAddressMethod::get_roles ( ) const

inline

Gets the optional 'roles' attribute.

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

◆ mutable_address()

string* google_civicinfo_api::RepresentativesResource_RepresentativeInfoByAddressMethod::mutable_address ( )

inline

Gets a modifiable pointer to the optional address' attribute.

Returns: The value can be set by dereferencing the pointer.

◆ mutable_levels()

client::JsonCppArray<string >* google_civicinfo_api::RepresentativesResource_RepresentativeInfoByAddressMethod::mutable_levels ( )

inline

Gets a modifiable pointer to the optional levels' attribute.

Returns: The value can be set by dereferencing the pointer.

◆ mutable_roles()

client::JsonCppArray<string >* google_civicinfo_api::RepresentativesResource_RepresentativeInfoByAddressMethod::mutable_roles ( )

inline

Gets a modifiable pointer to the optional roles' attribute.

Returns: The value can be set by dereferencing the pointer.

◆ set_address()

void google_civicinfo_api::RepresentativesResource_RepresentativeInfoByAddressMethod::set_address ( const string & value )

inline

Sets the 'address' attribute.

Parameters

[in] value The address to look up. May only be specified if the field ocdId is not given in the URL.

◆ set_include_offices()

void google_civicinfo_api::RepresentativesResource_RepresentativeInfoByAddressMethod::set_include_offices ( bool value )

inline

Sets the 'includeOffices' attribute.

Parameters

[in] value Whether to return information about offices and officials. If false, only the top-level district information will be returned.

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

google/civicinfo_api/civic_info_service.h
google/civicinfo_api/civic_info_service.cc

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RepresentativesResource_RepresentativeInfoByAddressMethod()

◆ ~RepresentativesResource_RepresentativeInfoByAddressMethod()

Member Function Documentation

◆ AppendOptionalQueryParameters()

◆ AppendVariable()

◆ clear_address()

◆ clear_include_offices()

◆ clear_levels()

◆ clear_roles()

◆ ExecuteAndParseResponse()

◆ get_address()

◆ get_include_offices()

◆ get_levels()

◆ get_roles()

◆ mutable_address()

◆ mutable_levels()

◆ mutable_roles()

◆ set_address()

◆ set_include_offices()