youtube  v3
Public Member Functions | Static Public Member Functions | List of all members
google_youtube_api::PlaylistItem Class Reference

#include <playlist_item.h>

Inheritance diagram for google_youtube_api::PlaylistItem:

Public Member Functions

 PlaylistItem (const Json::Value &storage)
 
 PlaylistItem (Json::Value *storage)
 
virtual ~PlaylistItem ()
 
const StringPiece GetTypeName () const
 
bool has_content_details () const
 
void clear_content_details ()
 
const PlaylistItemContentDetails get_content_details () const
 
PlaylistItemContentDetails mutable_contentDetails ()
 
bool has_etag () const
 
void clear_etag ()
 
const StringPiece get_etag () const
 
void set_etag (const StringPiece &value)
 
bool has_id () const
 
void clear_id ()
 
const StringPiece get_id () const
 
void set_id (const StringPiece &value)
 
bool has_kind () const
 
void clear_kind ()
 
const StringPiece get_kind () const
 
void set_kind (const StringPiece &value)
 
bool has_snippet () const
 
void clear_snippet ()
 
const PlaylistItemSnippet get_snippet () const
 
PlaylistItemSnippet mutable_snippet ()
 
bool has_status () const
 
void clear_status ()
 
const PlaylistItemStatus get_status () const
 
PlaylistItemStatus mutable_status ()
 

Static Public Member Functions

static PlaylistItemNew ()
 

Detailed Description

A playlistItem resource identifies another resource, such as a video, that is included in a playlist. In addition, the playlistItem resource contains details about the included resource that pertain specifically to how that resource is used in that playlist.

YouTube uses playlists to identify special collections of videos for a channel, such as:

You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel. You can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods. For example, if a user gives a positive rating to a video, you would insert that video into the liked videos playlist for that user's channel.

Constructor & Destructor Documentation

◆ PlaylistItem() [1/2]

google_youtube_api::PlaylistItem::PlaylistItem ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ PlaylistItem() [2/2]

google_youtube_api::PlaylistItem::PlaylistItem ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~PlaylistItem()

google_youtube_api::PlaylistItem::~PlaylistItem ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_content_details()

void google_youtube_api::PlaylistItem::clear_content_details ( )
inline

Clears the 'contentDetails' attribute.

◆ clear_etag()

void google_youtube_api::PlaylistItem::clear_etag ( )
inline

Clears the 'etag' attribute.

◆ clear_id()

void google_youtube_api::PlaylistItem::clear_id ( )
inline

Clears the 'id' attribute.

◆ clear_kind()

void google_youtube_api::PlaylistItem::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_snippet()

void google_youtube_api::PlaylistItem::clear_snippet ( )
inline

Clears the 'snippet' attribute.

◆ clear_status()

void google_youtube_api::PlaylistItem::clear_status ( )
inline

Clears the 'status' attribute.

◆ get_content_details()

const PlaylistItemContentDetails google_youtube_api::PlaylistItem::get_content_details ( ) const

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

◆ get_etag()

const StringPiece google_youtube_api::PlaylistItem::get_etag ( ) const
inline

Get the value of the 'etag' attribute.

◆ get_id()

const StringPiece google_youtube_api::PlaylistItem::get_id ( ) const
inline

Get the value of the 'id' attribute.

◆ get_kind()

const StringPiece google_youtube_api::PlaylistItem::get_kind ( ) const
inline

Get the value of the 'kind' attribute.

◆ get_snippet()

const PlaylistItemSnippet google_youtube_api::PlaylistItem::get_snippet ( ) const

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

◆ get_status()

const PlaylistItemStatus google_youtube_api::PlaylistItem::get_status ( ) const

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

◆ GetTypeName()

const StringPiece google_youtube_api::PlaylistItem::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_youtube_api::PlaylistItem

◆ has_content_details()

bool google_youtube_api::PlaylistItem::has_content_details ( ) const
inline

Determine if the 'contentDetails' attribute was set.

Returns
true if the 'contentDetails' attribute was set.

◆ has_etag()

bool google_youtube_api::PlaylistItem::has_etag ( ) const
inline

Determine if the 'etag' attribute was set.

Returns
true if the 'etag' attribute was set.

◆ has_id()

bool google_youtube_api::PlaylistItem::has_id ( ) const
inline

Determine if the 'id' attribute was set.

Returns
true if the 'id' attribute was set.

◆ has_kind()

bool google_youtube_api::PlaylistItem::has_kind ( ) const
inline

Determine if the 'kind' attribute was set.

Returns
true if the 'kind' attribute was set.

◆ has_snippet()

bool google_youtube_api::PlaylistItem::has_snippet ( ) const
inline

Determine if the 'snippet' attribute was set.

Returns
true if the 'snippet' attribute was set.

◆ has_status()

bool google_youtube_api::PlaylistItem::has_status ( ) const
inline

Determine if the 'status' attribute was set.

Returns
true if the 'status' attribute was set.

◆ mutable_contentDetails()

PlaylistItemContentDetails google_youtube_api::PlaylistItem::mutable_contentDetails ( )

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

The contentDetails object is included in the resource if the included item is a YouTube video. The object contains additional information about the video.

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

◆ mutable_snippet()

PlaylistItemSnippet google_youtube_api::PlaylistItem::mutable_snippet ( )

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

The snippet object contains basic details about the playlist item, such as its title and position in the playlist.

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

◆ mutable_status()

PlaylistItemStatus google_youtube_api::PlaylistItem::mutable_status ( )

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

The status object contains information about the playlist item's privacy status.

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

◆ New()

PlaylistItem * google_youtube_api::PlaylistItem::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_etag()

void google_youtube_api::PlaylistItem::set_etag ( const StringPiece &  value)
inline

Change the 'etag' attribute.

Etag of this resource.

Parameters
[in]valueThe new value.

◆ set_id()

void google_youtube_api::PlaylistItem::set_id ( const StringPiece &  value)
inline

Change the 'id' attribute.

The ID that YouTube uses to uniquely identify the playlist item.

Parameters
[in]valueThe new value.

◆ set_kind()

void google_youtube_api::PlaylistItem::set_kind ( const StringPiece &  value)
inline

Change the 'kind' attribute.

Identifies what kind of resource this is. Value: the fixed string "youtube#playlistItem".

Parameters
[in]valueThe new value.

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