#include <promotion.h>

Inheritance diagram for google_customsearch_api::Promotion:

Classes
class	PromotionBodyLines

class	PromotionImage

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

	Promotion (Json::Value *storage)

virtual	~Promotion ()

const StringPiece	GetTypeName () const

bool	has_body_lines () const

void	clear_body_lines ()

const client::JsonCppArray< PromotionBodyLines >	get_body_lines () const

client::JsonCppArray< PromotionBodyLines >	mutable_bodyLines ()

bool	has_display_link () const

void	clear_display_link ()

const StringPiece	get_display_link () const

void	set_display_link (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 PromotionImage	get_image () const

PromotionImage	mutable_image ()

bool	has_link () const

void	clear_link ()

const StringPiece	get_link () const

void	set_link (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 Promotion *	New ()

Detailed Description

Promotion result.

Constructor & Destructor Documentation

◆ Promotion() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

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

◆ Promotion() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

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

◆ ~Promotion()

google_customsearch_api::Promotion::~Promotion ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_body_lines()

void google_customsearch_api::Promotion::clear_body_lines ( )

inline

Clears the 'bodyLines' attribute.

◆ clear_display_link()

void google_customsearch_api::Promotion::clear_display_link ( )

inline

Clears the 'displayLink' attribute.

◆ clear_html_title()

void google_customsearch_api::Promotion::clear_html_title ( )

inline

Clears the 'htmlTitle' attribute.

◆ clear_image()

void google_customsearch_api::Promotion::clear_image ( )

inline

Clears the 'image' attribute.

◆ clear_link()

void google_customsearch_api::Promotion::clear_link ( )

inline

Clears the 'link' attribute.

◆ clear_title()

void google_customsearch_api::Promotion::clear_title ( )

inline

Clears the 'title' attribute.

◆ get_body_lines()

const client::JsonCppArray<PromotionBodyLines > google_customsearch_api::Promotion::get_body_lines ( ) const

inline

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

◆ get_display_link()

const StringPiece google_customsearch_api::Promotion::get_display_link ( ) const

inline

Get the value of the 'displayLink' attribute.

◆ get_html_title()

const StringPiece google_customsearch_api::Promotion::get_html_title ( ) const

inline

Get the value of the 'htmlTitle' attribute.

◆ get_image()

const PromotionImage google_customsearch_api::Promotion::get_image ( ) const

inline

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

◆ get_link()

const StringPiece google_customsearch_api::Promotion::get_link ( ) const

inline

Get the value of the 'link' attribute.

◆ get_title()

const StringPiece google_customsearch_api::Promotion::get_title ( ) const

inline

Get the value of the 'title' attribute.

◆ GetTypeName()

const StringPiece google_customsearch_api::Promotion::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_customsearch_api::Promotion

◆ has_body_lines()

bool google_customsearch_api::Promotion::has_body_lines ( ) const

inline

Determine if the 'bodyLines' attribute was set.

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

◆ has_display_link()

bool google_customsearch_api::Promotion::has_display_link ( ) const

inline

Determine if the 'displayLink' attribute was set.

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

◆ has_html_title()

bool google_customsearch_api::Promotion::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::Promotion::has_image ( ) const

inline

Determine if the 'image' attribute was set.

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

◆ has_link()

bool google_customsearch_api::Promotion::has_link ( ) const

inline

Determine if the 'link' attribute was set.

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

◆ has_title()

bool google_customsearch_api::Promotion::has_title ( ) const

inline

Determine if the 'title' attribute was set.

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

◆ mutable_bodyLines()

client::JsonCppArray<PromotionBodyLines > google_customsearch_api::Promotion::mutable_bodyLines ( )

inline

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

An array of block objects for this promotion. See [Google WebSearch Protocol reference](https://developers.google.com/custom-search/docs/xml_results) for more information.

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

◆ mutable_image()

PromotionImage google_customsearch_api::Promotion::mutable_image ( )

inline

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

Image belonging to a promotion.

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

◆ New()

Promotion * google_customsearch_api::Promotion::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_display_link()

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

inline

Change the 'displayLink' attribute.

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

Parameters

[in] value The new value.

◆ set_html_title()

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

inline

Change the 'htmlTitle' attribute.

The title of the promotion, in HTML.

Parameters

[in] value The new value.

◆ set_link()

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

inline

Change the 'link' attribute.

The URL of the promotion.

Parameters

[in] value The new value.

◆ set_title()

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

inline

Change the 'title' attribute.

The title of the promotion.

Parameters

[in] value The new value.

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

google/customsearch_api/promotion.h
google/customsearch_api/promotion.cc

Classes

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Promotion() [1/2]

◆ Promotion() [2/2]

◆ ~Promotion()

Member Function Documentation

◆ clear_body_lines()

◆ clear_display_link()

◆ clear_html_title()

◆ clear_image()

◆ clear_link()

◆ clear_title()

◆ get_body_lines()

◆ get_display_link()

◆ get_html_title()

◆ get_image()

◆ get_link()

◆ get_title()

◆ GetTypeName()

◆ has_body_lines()

◆ has_display_link()

◆ has_html_title()

◆ has_image()

◆ has_link()

◆ has_title()

◆ mutable_bodyLines()

◆ mutable_image()

◆ New()

◆ set_display_link()

◆ set_html_title()

◆ set_link()

◆ set_title()