#include <result.h>

Inheritance diagram for google_customsearch_api::Result:

Classes
class	ResultImage

class	ResultLabels

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

	Result (Json::Value *storage)

virtual	~Result ()

const StringPiece	GetTypeName () const

bool	has_cache_id () const

void	clear_cache_id ()

const StringPiece	get_cache_id () const

void	set_cache_id (const StringPiece &value)

bool	has_display_link () const

void	clear_display_link ()

const StringPiece	get_display_link () const

void	set_display_link (const StringPiece &value)

bool	has_file_format () const

void	clear_file_format ()

const StringPiece	get_file_format () const

void	set_file_format (const StringPiece &value)

bool	has_formatted_url () const

void	clear_formatted_url ()

const StringPiece	get_formatted_url () const

void	set_formatted_url (const StringPiece &value)

bool	has_html_formatted_url () const

void	clear_html_formatted_url ()

const StringPiece	get_html_formatted_url () const

void	set_html_formatted_url (const StringPiece &value)

bool	has_html_snippet () const

void	clear_html_snippet ()

const StringPiece	get_html_snippet () const

void	set_html_snippet (const StringPiece &value)

bool	has_html_title () const

void	clear_html_title ()

const StringPiece	get_html_title () const

void	set_html_title (const StringPiece &value)

bool	has_image () const

void	clear_image ()

const ResultImage	get_image () const

ResultImage	mutable_image ()

bool	has_kind () const

void	clear_kind ()

const StringPiece	get_kind () const

void	set_kind (const StringPiece &value)

bool	has_labels () const

void	clear_labels ()

const client::JsonCppArray< ResultLabels >	get_labels () const

client::JsonCppArray< ResultLabels >	mutable_labels ()

bool	has_link () const

void	clear_link ()

const StringPiece	get_link () const

void	set_link (const StringPiece &value)

bool	has_mime () const

void	clear_mime ()

const StringPiece	get_mime () const

void	set_mime (const StringPiece &value)

bool	has_pagemap () const

void	clear_pagemap ()

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

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

bool	has_snippet () const

void	clear_snippet ()

const StringPiece	get_snippet () const

void	set_snippet (const StringPiece &value)

bool	has_title () const

void	clear_title ()

const StringPiece	get_title () const

void	set_title (const StringPiece &value)

Static Public Member Functions
static Result *	New ()

Detailed Description

A custom search result.

Constructor & Destructor Documentation

◆ Result() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

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

◆ Result() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

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

◆ ~Result()

google_customsearch_api::Result::~Result ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_cache_id()

void google_customsearch_api::Result::clear_cache_id ( )

inline

Clears the 'cacheId' attribute.

◆ clear_display_link()

void google_customsearch_api::Result::clear_display_link ( )

inline

Clears the 'displayLink' attribute.

◆ clear_file_format()

void google_customsearch_api::Result::clear_file_format ( )

inline

Clears the 'fileFormat' attribute.

◆ clear_formatted_url()

void google_customsearch_api::Result::clear_formatted_url ( )

inline

Clears the 'formattedUrl' attribute.

◆ clear_html_formatted_url()

void google_customsearch_api::Result::clear_html_formatted_url ( )

inline

Clears the 'htmlFormattedUrl' attribute.

◆ clear_html_snippet()

void google_customsearch_api::Result::clear_html_snippet ( )

inline

Clears the 'htmlSnippet' attribute.

◆ clear_html_title()

void google_customsearch_api::Result::clear_html_title ( )

inline

Clears the 'htmlTitle' attribute.

◆ clear_image()

void google_customsearch_api::Result::clear_image ( )

inline

Clears the 'image' attribute.

◆ clear_kind()

void google_customsearch_api::Result::clear_kind ( )

inline

Clears the 'kind' attribute.

◆ clear_labels()

void google_customsearch_api::Result::clear_labels ( )

inline

Clears the 'labels' attribute.

◆ clear_link()

void google_customsearch_api::Result::clear_link ( )

inline

Clears the 'link' attribute.

◆ clear_mime()

void google_customsearch_api::Result::clear_mime ( )

inline

Clears the 'mime' attribute.

◆ clear_pagemap()

void google_customsearch_api::Result::clear_pagemap ( )

inline

Clears the 'pagemap' attribute.

◆ clear_snippet()

void google_customsearch_api::Result::clear_snippet ( )

inline

Clears the 'snippet' attribute.

◆ clear_title()

void google_customsearch_api::Result::clear_title ( )

inline

Clears the 'title' attribute.

◆ get_cache_id()

const StringPiece google_customsearch_api::Result::get_cache_id ( ) const

inline

Get the value of the 'cacheId' attribute.

◆ get_display_link()

const StringPiece google_customsearch_api::Result::get_display_link ( ) const

inline

Get the value of the 'displayLink' attribute.

◆ get_file_format()

const StringPiece google_customsearch_api::Result::get_file_format ( ) const

inline

Get the value of the 'fileFormat' attribute.

◆ get_formatted_url()

const StringPiece google_customsearch_api::Result::get_formatted_url ( ) const

inline

Get the value of the 'formattedUrl' attribute.

◆ get_html_formatted_url()

const StringPiece google_customsearch_api::Result::get_html_formatted_url ( ) const

inline

Get the value of the 'htmlFormattedUrl' attribute.

◆ get_html_snippet()

const StringPiece google_customsearch_api::Result::get_html_snippet ( ) const

inline

Get the value of the 'htmlSnippet' attribute.

◆ get_html_title()

const StringPiece google_customsearch_api::Result::get_html_title ( ) const

inline

Get the value of the 'htmlTitle' attribute.

◆ get_image()

const ResultImage google_customsearch_api::Result::get_image ( ) const

inline

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

◆ get_kind()

const StringPiece google_customsearch_api::Result::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

◆ get_labels()

const client::JsonCppArray<ResultLabels > google_customsearch_api::Result::get_labels ( ) const

inline

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

◆ get_link()

const StringPiece google_customsearch_api::Result::get_link ( ) const

inline

Get the value of the 'link' attribute.

◆ get_mime()

const StringPiece google_customsearch_api::Result::get_mime ( ) const

inline

Get the value of the 'mime' attribute.

◆ get_pagemap()

const client::JsonCppAssociativeArray<client::JsonCppData > google_customsearch_api::Result::get_pagemap ( ) const

inline

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

◆ get_snippet()

const StringPiece google_customsearch_api::Result::get_snippet ( ) const

inline

Get the value of the 'snippet' attribute.

◆ get_title()

const StringPiece google_customsearch_api::Result::get_title ( ) const

inline

Get the value of the 'title' attribute.

◆ GetTypeName()

const StringPiece google_customsearch_api::Result::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_customsearch_api::Result

◆ has_cache_id()

bool google_customsearch_api::Result::has_cache_id ( ) const

inline

Determine if the 'cacheId' attribute was set.

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

◆ has_display_link()

bool google_customsearch_api::Result::has_display_link ( ) const

inline

Determine if the 'displayLink' attribute was set.

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

◆ has_file_format()

bool google_customsearch_api::Result::has_file_format ( ) const

inline

Determine if the 'fileFormat' attribute was set.

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

◆ has_formatted_url()

bool google_customsearch_api::Result::has_formatted_url ( ) const

inline

Determine if the 'formattedUrl' attribute was set.

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

◆ has_html_formatted_url()

bool google_customsearch_api::Result::has_html_formatted_url ( ) const

inline

Determine if the 'htmlFormattedUrl' attribute was set.

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

◆ has_html_snippet()

bool google_customsearch_api::Result::has_html_snippet ( ) const

inline

Determine if the 'htmlSnippet' attribute was set.

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

◆ has_html_title()

bool google_customsearch_api::Result::has_html_title ( ) const

inline

Determine if the 'htmlTitle' attribute was set.

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

◆ has_image()

bool google_customsearch_api::Result::has_image ( ) const

inline

Determine if the 'image' attribute was set.

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

◆ has_kind()

bool google_customsearch_api::Result::has_kind ( ) const

inline

Determine if the 'kind' attribute was set.

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

◆ has_labels()

bool google_customsearch_api::Result::has_labels ( ) const

inline

Determine if the 'labels' attribute was set.

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

◆ has_link()

bool google_customsearch_api::Result::has_link ( ) const

inline

Determine if the 'link' attribute was set.

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

◆ has_mime()

bool google_customsearch_api::Result::has_mime ( ) const

inline

Determine if the 'mime' attribute was set.

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

◆ has_pagemap()

bool google_customsearch_api::Result::has_pagemap ( ) const

inline

Determine if the 'pagemap' attribute was set.

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

◆ has_snippet()

bool google_customsearch_api::Result::has_snippet ( ) const

inline

Determine if the 'snippet' attribute was set.

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

◆ has_title()

bool google_customsearch_api::Result::has_title ( ) const

inline

Determine if the 'title' attribute was set.

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

◆ mutable_image()

ResultImage google_customsearch_api::Result::mutable_image ( )

inline

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

Image belonging to a custom search result.

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

◆ mutable_labels()

client::JsonCppArray<ResultLabels > google_customsearch_api::Result::mutable_labels ( )

inline

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

Encapsulates all information about refinement labels.

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

◆ mutable_pagemap()

client::JsonCppAssociativeArray<client::JsonCppData > google_customsearch_api::Result::mutable_pagemap ( )

inline

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

Contains PageMap information for this search result.

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

◆ New()

Result * google_customsearch_api::Result::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_cache_id()

void google_customsearch_api::Result::set_cache_id ( const StringPiece & value )

inline

Change the 'cacheId' attribute.

Indicates the ID of Google's cached version of the search result.

Parameters

[in] value The new value.

◆ set_display_link()

void google_customsearch_api::Result::set_display_link ( const StringPiece & value )

inline

Change the 'displayLink' attribute.

An abridged version of this search result’s URL, e.g. www.example.com.

Parameters

[in] value The new value.

◆ set_file_format()

void google_customsearch_api::Result::set_file_format ( const StringPiece & value )

inline

Change the 'fileFormat' attribute.

The file format of the search result.

Parameters

[in] value The new value.

◆ set_formatted_url()

void google_customsearch_api::Result::set_formatted_url ( const StringPiece & value )

inline

Change the 'formattedUrl' attribute.

The URL displayed after the snippet for each search result.

Parameters

[in] value The new value.

◆ set_html_formatted_url()

void google_customsearch_api::Result::set_html_formatted_url ( const StringPiece & value )

inline

Change the 'htmlFormattedUrl' attribute.

The HTML-formatted URL displayed after the snippet for each search result.

Parameters

[in] value The new value.

◆ set_html_snippet()

void google_customsearch_api::Result::set_html_snippet ( const StringPiece & value )

inline

Change the 'htmlSnippet' attribute.

The snippet of the search result, in HTML.

Parameters

[in] value The new value.

◆ set_html_title()

void google_customsearch_api::Result::set_html_title ( const StringPiece & value )

inline

Change the 'htmlTitle' attribute.

The title of the search result, in HTML.

Parameters

[in] value The new value.

◆ set_kind()

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

inline

Change the 'kind' attribute.

A unique identifier for the type of current object. For this API, it is customsearch::result..

Parameters

[in] value The new value.

◆ set_link()

void google_customsearch_api::Result::set_link ( const StringPiece & value )

inline

Change the 'link' attribute.

The full URL to which the search result is pointing, e.g. http://www.example.com/foo/bar.

Parameters

[in] value The new value.

◆ set_mime()

void google_customsearch_api::Result::set_mime ( const StringPiece & value )

inline

Change the 'mime' attribute.

The MIME type of the search result.

Parameters

[in] value The new value.

◆ set_snippet()

void google_customsearch_api::Result::set_snippet ( const StringPiece & value )

inline

Change the 'snippet' attribute.

The snippet of the search result, in plain text.

Parameters

[in] value The new value.

◆ set_title()

void google_customsearch_api::Result::set_title ( const StringPiece & value )

inline

Change the 'title' attribute.

The title of the search result, in plain text.

Parameters

[in] value The new value.

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

google/customsearch_api/result.h
google/customsearch_api/result.cc

Classes

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Result() [1/2]

◆ Result() [2/2]

◆ ~Result()

Member Function Documentation

◆ clear_cache_id()

◆ clear_display_link()

◆ clear_file_format()

◆ clear_formatted_url()

◆ clear_html_formatted_url()

◆ clear_html_snippet()

◆ clear_html_title()

◆ clear_image()

◆ clear_kind()

◆ clear_labels()

◆ clear_link()

◆ clear_mime()

◆ clear_pagemap()

◆ clear_snippet()

◆ clear_title()

◆ get_cache_id()

◆ get_display_link()

◆ get_file_format()

◆ get_formatted_url()

◆ get_html_formatted_url()

◆ get_html_snippet()

◆ get_html_title()

◆ get_image()

◆ get_kind()

◆ get_labels()

◆ get_link()

◆ get_mime()

◆ get_pagemap()

◆ get_snippet()

◆ get_title()

◆ GetTypeName()

◆ has_cache_id()

◆ has_display_link()

◆ has_file_format()

◆ has_formatted_url()

◆ has_html_formatted_url()

◆ has_html_snippet()

◆ has_html_title()

◆ has_image()

◆ has_kind()

◆ has_labels()

◆ has_link()

◆ has_mime()

◆ has_pagemap()

◆ has_snippet()

◆ has_title()

◆ mutable_image()

◆ mutable_labels()

◆ mutable_pagemap()

◆ New()

◆ set_cache_id()

◆ set_display_link()

◆ set_file_format()

◆ set_formatted_url()

◆ set_html_formatted_url()

◆ set_html_snippet()

◆ set_html_title()

◆ set_kind()

◆ set_link()

◆ set_mime()

◆ set_snippet()

◆ set_title()