google_youtube_api::PromotedItem Class Reference

#include <promoted_item.h>

Inheritance diagram for google_youtube_api::PromotedItem:

Public Member Functions
	PromotedItem (const Json::Value &storage)
	PromotedItem (Json::Value *storage)
virtual	~PromotedItem ()
const StringPiece	GetTypeName () const
bool	has_custom_message () const
void	clear_custom_message ()
const StringPiece	get_custom_message () const
void	set_custom_message (const StringPiece &value)
bool	has_id () const
void	clear_id ()
const PromotedItemId	get_id () const
PromotedItemId	mutable_id ()
bool	has_promoted_by_content_owner () const
void	clear_promoted_by_content_owner ()
bool	get_promoted_by_content_owner () const
void	set_promoted_by_content_owner (bool value)
bool	has_timing () const
void	clear_timing ()
const InvideoTiming	get_timing () const
InvideoTiming	mutable_timing ()

Static Public Member Functions
static PromotedItem *	New ()

Detailed Description

Describes a single promoted item.

Constructor & Destructor Documentation

PromotedItem() [1/2]

google_youtube_api::PromotedItem::PromotedItem ( const Json::Value &  storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

PromotedItem() [2/2]

google_youtube_api::PromotedItem::PromotedItem ( Json::Value *  storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~PromotedItem()

google_youtube_api::PromotedItem::~PromotedItem ( )

virtual

Standard destructor.

Member Function Documentation

clear_custom_message()

void google_youtube_api::PromotedItem::clear_custom_message ( )

inline

Clears the 'customMessage' attribute.

clear_id()

void google_youtube_api::PromotedItem::clear_id ( )

inline

Clears the 'id' attribute.

clear_promoted_by_content_owner()

void google_youtube_api::PromotedItem::clear_promoted_by_content_owner ( )

inline

Clears the 'promotedByContentOwner' attribute.

clear_timing()

void google_youtube_api::PromotedItem::clear_timing ( )

inline

Clears the 'timing' attribute.

get_custom_message()

const StringPiece google_youtube_api::PromotedItem::get_custom_message ( ) const

inline

Get the value of the 'customMessage' attribute.

get_id()

const PromotedItemId google_youtube_api::PromotedItem::get_id

(

)

const

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

get_promoted_by_content_owner()

bool google_youtube_api::PromotedItem::get_promoted_by_content_owner ( ) const

inline

Get the value of the 'promotedByContentOwner' attribute.

get_timing()

const InvideoTiming google_youtube_api::PromotedItem::get_timing

(

)

const

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

GetTypeName()

const StringPiece google_youtube_api::PromotedItem::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_youtube_api::PromotedItem

has_custom_message()

bool google_youtube_api::PromotedItem::has_custom_message ( ) const

inline

Determine if the 'customMessage' attribute was set.

Returns

true if the 'customMessage' attribute was set.

has_id()

bool google_youtube_api::PromotedItem::has_id ( ) const

inline

Determine if the 'id' attribute was set.

Returns

true if the 'id' attribute was set.

has_promoted_by_content_owner()

bool google_youtube_api::PromotedItem::has_promoted_by_content_owner ( ) const

inline

Determine if the 'promotedByContentOwner' attribute was set.

Returns

true if the 'promotedByContentOwner' attribute was set.

has_timing()

bool google_youtube_api::PromotedItem::has_timing ( ) const

inline

Determine if the 'timing' attribute was set.

Returns

true if the 'timing' attribute was set.

mutable_id()

PromotedItemId google_youtube_api::PromotedItem::mutable_id

(

)

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

Identifies the promoted item.

Returns

The result can be modified to change the attribute value.

mutable_timing()

InvideoTiming google_youtube_api::PromotedItem::mutable_timing

(

)

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

The temporal position within the video where the promoted item will be displayed. If present, it overrides the default timing.

Returns

The result can be modified to change the attribute value.

New()

PromotedItem * google_youtube_api::PromotedItem::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_custom_message()

void google_youtube_api::PromotedItem::set_custom_message ( const StringPiece &  value )

inline

Change the 'customMessage' attribute.

A custom message to display for this promotion. This field is currently ignored unless the promoted item is a website.

Parameters

[in]

value

The new value.

set_promoted_by_content_owner()

void google_youtube_api::PromotedItem::set_promoted_by_content_owner ( bool  value )

inline

Change the 'promotedByContentOwner' attribute.

If true, the content owner's name will be used when displaying the promotion. This field can only be set when the update is made on behalf of the content owner.

Parameters

[in]

value

The new value.

---

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

• google/youtube_api/promoted_item.h
• google/youtube_api/promoted_item.cc