google_youtube_api::PromotedItemId Class Reference

#include <promoted_item_id.h>

Inheritance diagram for google_youtube_api::PromotedItemId:

Public Member Functions
	PromotedItemId (const Json::Value &storage)
	PromotedItemId (Json::Value *storage)
virtual	~PromotedItemId ()
const StringPiece	GetTypeName () const
bool	has_recently_uploaded_by () const
void	clear_recently_uploaded_by ()
const StringPiece	get_recently_uploaded_by () const
void	set_recently_uploaded_by (const StringPiece &value)
bool	has_type () const
void	clear_type ()
const StringPiece	get_type () const
void	set_type (const StringPiece &value)
bool	has_video_id () const
void	clear_video_id ()
const StringPiece	get_video_id () const
void	set_video_id (const StringPiece &value)
bool	has_website_url () const
void	clear_website_url ()
const StringPiece	get_website_url () const
void	set_website_url (const StringPiece &value)

Static Public Member Functions
static PromotedItemId *	New ()

Detailed Description

Describes a single promoted item id. It is a union of various possible types.

Constructor & Destructor Documentation

PromotedItemId() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

PromotedItemId() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~PromotedItemId()

google_youtube_api::PromotedItemId::~PromotedItemId ( )

virtual

Standard destructor.

Member Function Documentation

clear_recently_uploaded_by()

void google_youtube_api::PromotedItemId::clear_recently_uploaded_by ( )

inline

Clears the 'recentlyUploadedBy' attribute.

clear_type()

void google_youtube_api::PromotedItemId::clear_type ( )

inline

Clears the 'type' attribute.

clear_video_id()

void google_youtube_api::PromotedItemId::clear_video_id ( )

inline

Clears the 'videoId' attribute.

clear_website_url()

void google_youtube_api::PromotedItemId::clear_website_url ( )

inline

Clears the 'websiteUrl' attribute.

get_recently_uploaded_by()

const StringPiece google_youtube_api::PromotedItemId::get_recently_uploaded_by ( ) const

inline

Get the value of the 'recentlyUploadedBy' attribute.

get_type()

const StringPiece google_youtube_api::PromotedItemId::get_type ( ) const

inline

Get the value of the 'type' attribute.

get_video_id()

const StringPiece google_youtube_api::PromotedItemId::get_video_id ( ) const

inline

Get the value of the 'videoId' attribute.

get_website_url()

const StringPiece google_youtube_api::PromotedItemId::get_website_url ( ) const

inline

Get the value of the 'websiteUrl' attribute.

GetTypeName()

const StringPiece google_youtube_api::PromotedItemId::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_youtube_api::PromotedItemId

has_recently_uploaded_by()

bool google_youtube_api::PromotedItemId::has_recently_uploaded_by ( ) const

inline

Determine if the 'recentlyUploadedBy' attribute was set.

Returns

true if the 'recentlyUploadedBy' attribute was set.

has_type()

bool google_youtube_api::PromotedItemId::has_type ( ) const

inline

Determine if the 'type' attribute was set.

Returns

true if the 'type' attribute was set.

has_video_id()

bool google_youtube_api::PromotedItemId::has_video_id ( ) const

inline

Determine if the 'videoId' attribute was set.

Returns

true if the 'videoId' attribute was set.

has_website_url()

bool google_youtube_api::PromotedItemId::has_website_url ( ) const

inline

Determine if the 'websiteUrl' attribute was set.

Returns

true if the 'websiteUrl' attribute was set.

New()

PromotedItemId * google_youtube_api::PromotedItemId::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_recently_uploaded_by()

void google_youtube_api::PromotedItemId::set_recently_uploaded_by ( const StringPiece &  value )

inline

Change the 'recentlyUploadedBy' attribute.

If type is recentUpload, this field identifies the channel from which to take the recent upload. If missing, the channel is assumed to be the same channel for which the invideoPromotion is set.

Parameters

[in]

value

The new value.

set_type()

void google_youtube_api::PromotedItemId::set_type ( const StringPiece &  value )

inline

Change the 'type' attribute.

Describes the type of the promoted item.

Parameters

[in]

value

The new value.

set_video_id()

void google_youtube_api::PromotedItemId::set_video_id ( const StringPiece &  value )

inline

Change the 'videoId' attribute.

If the promoted item represents a video, this field represents the unique YouTube ID identifying it. This field will be present only if type has the value video.

Parameters

[in]

value

The new value.

set_website_url()

void google_youtube_api::PromotedItemId::set_website_url ( const StringPiece &  value )

inline

Change the 'websiteUrl' attribute.

If the promoted item represents a website, this field represents the url pointing to the website. This field will be present only if type has the value website.

Parameters

[in]

value

The new value.

---

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

• google/youtube_api/promoted_item_id.h
• google/youtube_api/promoted_item_id.cc