#include <search.h>

Inheritance diagram for google_customsearch_api::Search:

Classes
class	SearchQueries

class	SearchSearchInformation

class	SearchSpelling

class	SearchUrl

Public Member Functions
	Search (const Json::Value &storage)

	Search (Json::Value *storage)

virtual	~Search ()

const StringPiece	GetTypeName () const

bool	has_context () const

void	clear_context ()

const client::JsonCppAssociativeArray< client::JsonCppData >	get_context () const

client::JsonCppAssociativeArray< client::JsonCppData >	mutable_context ()

bool	has_items () const

void	clear_items ()

const client::JsonCppArray< Result >	get_items () const

client::JsonCppArray< Result >	mutable_items ()

bool	has_kind () const

void	clear_kind ()

const StringPiece	get_kind () const

void	set_kind (const StringPiece &value)

bool	has_promotions () const

void	clear_promotions ()

const client::JsonCppArray< Promotion >	get_promotions () const

client::JsonCppArray< Promotion >	mutable_promotions ()

bool	has_queries () const

void	clear_queries ()

const SearchQueries	get_queries () const

SearchQueries	mutable_queries ()

bool	has_search_information () const

void	clear_search_information ()

const SearchSearchInformation	get_search_information () const

SearchSearchInformation	mutable_searchInformation ()

bool	has_spelling () const

void	clear_spelling ()

const SearchSpelling	get_spelling () const

SearchSpelling	mutable_spelling ()

bool	has_url () const

void	clear_url ()

const SearchUrl	get_url () const

SearchUrl	mutable_url ()

Static Public Member Functions
static Search *	New ()

Detailed Description

Response to a custom search request.

Constructor & Destructor Documentation

◆ Search() [1/2]

google_customsearch_api::Search::Search ( const Json::Value & storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ Search() [2/2]

google_customsearch_api::Search::Search ( Json::Value * storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ ~Search()

google_customsearch_api::Search::~Search ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_context()

void google_customsearch_api::Search::clear_context ( )

inline

Clears the 'context' attribute.

◆ clear_items()

void google_customsearch_api::Search::clear_items ( )

inline

Clears the 'items' attribute.

◆ clear_kind()

void google_customsearch_api::Search::clear_kind ( )

inline

Clears the 'kind' attribute.

◆ clear_promotions()

void google_customsearch_api::Search::clear_promotions ( )

inline

Clears the 'promotions' attribute.

◆ clear_queries()

void google_customsearch_api::Search::clear_queries ( )

inline

Clears the 'queries' attribute.

◆ clear_search_information()

void google_customsearch_api::Search::clear_search_information ( )

inline

Clears the 'searchInformation' attribute.

◆ clear_spelling()

void google_customsearch_api::Search::clear_spelling ( )

inline

Clears the 'spelling' attribute.

◆ clear_url()

void google_customsearch_api::Search::clear_url ( )

inline

Clears the 'url' attribute.

◆ get_context()

const client::JsonCppAssociativeArray<client::JsonCppData > google_customsearch_api::Search::get_context ( ) const

inline

Get a reference to the value of the 'context' attribute.

◆ get_items()

const client::JsonCppArray<Result > google_customsearch_api::Search::get_items ( ) const

Get a reference to the value of the 'items' attribute.

◆ get_kind()

const StringPiece google_customsearch_api::Search::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

◆ get_promotions()

const client::JsonCppArray<Promotion > google_customsearch_api::Search::get_promotions ( ) const

Get a reference to the value of the 'promotions' attribute.

◆ get_queries()

const SearchQueries google_customsearch_api::Search::get_queries ( ) const

inline

Get a reference to the value of the 'queries' attribute.

◆ get_search_information()

const SearchSearchInformation google_customsearch_api::Search::get_search_information ( ) const

inline

Get a reference to the value of the 'searchInformation' attribute.

◆ get_spelling()

const SearchSpelling google_customsearch_api::Search::get_spelling ( ) const

inline

Get a reference to the value of the 'spelling' attribute.

◆ get_url()

const SearchUrl google_customsearch_api::Search::get_url ( ) const

inline

Get a reference to the value of the 'url' attribute.

◆ GetTypeName()

const StringPiece google_customsearch_api::Search::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_customsearch_api::Search

◆ has_context()

bool google_customsearch_api::Search::has_context ( ) const

inline

Determine if the 'context' attribute was set.

Returns: true if the 'context' attribute was set.

◆ has_items()

bool google_customsearch_api::Search::has_items ( ) const

inline

Determine if the 'items' attribute was set.

Returns: true if the 'items' attribute was set.

◆ has_kind()

bool google_customsearch_api::Search::has_kind ( ) const

inline

Determine if the 'kind' attribute was set.

Returns: true if the 'kind' attribute was set.

◆ has_promotions()

bool google_customsearch_api::Search::has_promotions ( ) const

inline

Determine if the 'promotions' attribute was set.

Returns: true if the 'promotions' attribute was set.

◆ has_queries()

bool google_customsearch_api::Search::has_queries ( ) const

inline

Determine if the 'queries' attribute was set.

Returns: true if the 'queries' attribute was set.

◆ has_search_information()

bool google_customsearch_api::Search::has_search_information ( ) const

inline

Determine if the 'searchInformation' attribute was set.

Returns: true if the 'searchInformation' attribute was set.

◆ has_spelling()

bool google_customsearch_api::Search::has_spelling ( ) const

inline

Determine if the 'spelling' attribute was set.

Returns: true if the 'spelling' attribute was set.

◆ has_url()

bool google_customsearch_api::Search::has_url ( ) const

inline

Determine if the 'url' attribute was set.

Returns: true if the 'url' attribute was set.

◆ mutable_context()

client::JsonCppAssociativeArray<client::JsonCppData > google_customsearch_api::Search::mutable_context ( )

inline

Gets a reference to a mutable value of the 'context' property.

Metadata and refinements associated with the given search engine, including:

The name of the search engine that was used for the query.
A set of facet objects (refinements) you can use for refining a search.

Returns: The result can be modified to change the attribute value.

◆ mutable_items()

client::JsonCppArray<Result > google_customsearch_api::Search::mutable_items ( )

Gets a reference to a mutable value of the 'items' property.

The current set of custom search results.

Returns: The result can be modified to change the attribute value.

◆ mutable_promotions()

client::JsonCppArray<Promotion > google_customsearch_api::Search::mutable_promotions ( )

Gets a reference to a mutable value of the 'promotions' property.

The set of promotions. Present only if the custom search engine's configuration files define any promotions for the given query.

Returns: The result can be modified to change the attribute value.

◆ mutable_queries()

SearchQueries google_customsearch_api::Search::mutable_queries ( )

inline

Gets a reference to a mutable value of the 'queries' property.

Query metadata for the previous, current, and next pages of results.

Returns: The result can be modified to change the attribute value.

◆ mutable_searchInformation()

SearchSearchInformation google_customsearch_api::Search::mutable_searchInformation ( )

inline

Gets a reference to a mutable value of the 'searchInformation' property.

Metadata about a search operation.

Returns: The result can be modified to change the attribute value.

◆ mutable_spelling()

SearchSpelling google_customsearch_api::Search::mutable_spelling ( )

inline

Gets a reference to a mutable value of the 'spelling' property.

Spell correction information for a query.

Returns: The result can be modified to change the attribute value.

◆ mutable_url()

SearchUrl google_customsearch_api::Search::mutable_url ( )

inline

Gets a reference to a mutable value of the 'url' property.

OpenSearch template and URL.

Returns: The result can be modified to change the attribute value.

◆ New()

Search * google_customsearch_api::Search::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_kind()

void google_customsearch_api::Search::set_kind ( const StringPiece & value )

inline

Change the 'kind' attribute.

Unique identifier for the type of current object. For this API, it is customsearch::search.

Parameters

[in] value The new value.

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

google/customsearch_api/search.h
google/customsearch_api/search.cc

Classes

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Search() [1/2]

◆ Search() [2/2]

◆ ~Search()

Member Function Documentation

◆ clear_context()

◆ clear_items()

◆ clear_kind()

◆ clear_promotions()

◆ clear_queries()

◆ clear_search_information()

◆ clear_spelling()

◆ clear_url()

◆ get_context()

◆ get_items()

◆ get_kind()

◆ get_promotions()

◆ get_queries()

◆ get_search_information()

◆ get_spelling()

◆ get_url()

◆ GetTypeName()

◆ has_context()

◆ has_items()

◆ has_kind()

◆ has_promotions()

◆ has_queries()

◆ has_search_information()

◆ has_spelling()

◆ has_url()

◆ mutable_context()

◆ mutable_items()

◆ mutable_promotions()

◆ mutable_queries()

◆ mutable_searchInformation()

◆ mutable_spelling()

◆ mutable_url()

◆ New()

◆ set_kind()