google_customsearch_api::Result::ResultLabels Class Reference

#include <result.h>

Inheritance diagram for google_customsearch_api::Result::ResultLabels:

Public Member Functions
	ResultLabels (const Json::Value &storage)
	ResultLabels (Json::Value *storage)
virtual	~ResultLabels ()
const StringPiece	GetTypeName () const
bool	has_display_name () const
void	clear_display_name ()
const StringPiece	get_display_name () const
void	set_display_name (const StringPiece &value)
bool	has_label_with_op () const
void	clear_label_with_op ()
const StringPiece	get_label_with_op () const
void	set_label_with_op (const StringPiece &value)
bool	has_name () const
void	clear_name ()
const StringPiece	get_name () const
void	set_name (const StringPiece &value)

Static Public Member Functions
static ResultLabels *	New ()

Detailed Description

Refinement label associated with a custom search result.

Constructor & Destructor Documentation

ResultLabels() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

ResultLabels() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~ResultLabels()

google_customsearch_api::Result::ResultLabels::~ResultLabels ( )

virtual

Standard destructor.

Member Function Documentation

clear_display_name()

void google_customsearch_api::Result::ResultLabels::clear_display_name ( )

inline

Clears the 'displayName' attribute.

clear_label_with_op()

void google_customsearch_api::Result::ResultLabels::clear_label_with_op ( )

inline

Clears the 'label_with_op' attribute.

clear_name()

void google_customsearch_api::Result::ResultLabels::clear_name ( )

inline

Clears the 'name' attribute.

get_display_name()

const StringPiece google_customsearch_api::Result::ResultLabels::get_display_name ( ) const

inline

Get the value of the 'displayName' attribute.

get_label_with_op()

const StringPiece google_customsearch_api::Result::ResultLabels::get_label_with_op ( ) const

inline

Get the value of the 'label_with_op' attribute.

get_name()

const StringPiece google_customsearch_api::Result::ResultLabels::get_name ( ) const

inline

Get the value of the 'name' attribute.

GetTypeName()

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

inline

Returns a string denoting the type of this data object.

Returns

google_customsearch_api::ResultLabels

has_display_name()

bool google_customsearch_api::Result::ResultLabels::has_display_name ( ) const

inline

Determine if the 'displayName' attribute was set.

Returns

true if the 'displayName' attribute was set.

has_label_with_op()

bool google_customsearch_api::Result::ResultLabels::has_label_with_op ( ) const

inline

Determine if the 'label_with_op' attribute was set.

Returns

true if the 'label_with_op' attribute was set.

has_name()

bool google_customsearch_api::Result::ResultLabels::has_name ( ) const

inline

Determine if the 'name' attribute was set.

Returns

true if the 'name' attribute was set.

New()

Result::ResultLabels * google_customsearch_api::Result::ResultLabels::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_display_name()

void google_customsearch_api::Result::ResultLabels::set_display_name ( const StringPiece &  value )

inline

Change the 'displayName' attribute.

The display name of a refinement label. This is the name you should display in your user interface.

Parameters

[in]

value

The new value.

set_label_with_op()

void google_customsearch_api::Result::ResultLabels::set_label_with_op ( const StringPiece &  value )

inline

Change the 'label_with_op' attribute.

Refinement label and the associated refinement operation.

Parameters

[in]

value

The new value.

set_name()

void google_customsearch_api::Result::ResultLabels::set_name ( const StringPiece &  value )

inline

Change the 'name' attribute.

The name of a refinement label, which you can use to refine searches. Don't display this in your user interface; instead, use displayName.

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