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

#include <playlist.h>

Inheritance diagram for google_youtube_api::Playlist:

Public Member Functions

 Playlist (const Json::Value &storage)
 
 Playlist (Json::Value *storage)
 
virtual ~Playlist ()
 
const StringPiece GetTypeName () const
 
bool has_content_details () const
 
void clear_content_details ()
 
const PlaylistContentDetails get_content_details () const
 
PlaylistContentDetails 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_localizations () const
 
void clear_localizations ()
 
const client::JsonCppAssociativeArray< PlaylistLocalizationget_localizations () const
 
client::JsonCppAssociativeArray< PlaylistLocalizationmutable_localizations ()
 
bool has_player () const
 
void clear_player ()
 
const PlaylistPlayer get_player () const
 
PlaylistPlayer mutable_player ()
 
bool has_snippet () const
 
void clear_snippet ()
 
const PlaylistSnippet get_snippet () const
 
PlaylistSnippet mutable_snippet ()
 
bool has_status () const
 
void clear_status ()
 
const PlaylistStatus get_status () const
 
PlaylistStatus mutable_status ()
 

Static Public Member Functions

static PlaylistNew ()
 

Detailed Description

A playlist resource represents a YouTube playlist. A playlist is a collection of videos that can be viewed sequentially and shared with other users. A playlist can contain up to 200 videos, and YouTube does not limit the number of playlists that each user creates. By default, playlists are publicly visible to other users, but playlists can be public or private.

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

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.

Constructor & Destructor Documentation

◆ Playlist() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ Playlist() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~Playlist()

google_youtube_api::Playlist::~Playlist ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_content_details()

void google_youtube_api::Playlist::clear_content_details ( )
inline

Clears the 'contentDetails' attribute.

◆ clear_etag()

void google_youtube_api::Playlist::clear_etag ( )
inline

Clears the 'etag' attribute.

◆ clear_id()

void google_youtube_api::Playlist::clear_id ( )
inline

Clears the 'id' attribute.

◆ clear_kind()

void google_youtube_api::Playlist::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_localizations()

void google_youtube_api::Playlist::clear_localizations ( )
inline

Clears the 'localizations' attribute.

◆ clear_player()

void google_youtube_api::Playlist::clear_player ( )
inline

Clears the 'player' attribute.

◆ clear_snippet()

void google_youtube_api::Playlist::clear_snippet ( )
inline

Clears the 'snippet' attribute.

◆ clear_status()

void google_youtube_api::Playlist::clear_status ( )
inline

Clears the 'status' attribute.

◆ get_content_details()

const PlaylistContentDetails google_youtube_api::Playlist::get_content_details ( ) const

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

◆ get_etag()

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

Get the value of the 'etag' attribute.

◆ get_id()

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

Get the value of the 'id' attribute.

◆ get_kind()

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

Get the value of the 'kind' attribute.

◆ get_localizations()

const client::JsonCppAssociativeArray<PlaylistLocalization > google_youtube_api::Playlist::get_localizations ( ) const

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

◆ get_player()

const PlaylistPlayer google_youtube_api::Playlist::get_player ( ) const

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

◆ get_snippet()

const PlaylistSnippet google_youtube_api::Playlist::get_snippet ( ) const

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

◆ get_status()

const PlaylistStatus google_youtube_api::Playlist::get_status ( ) const

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

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_youtube_api::Playlist

◆ has_content_details()

bool google_youtube_api::Playlist::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::Playlist::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::Playlist::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::Playlist::has_kind ( ) const
inline

Determine if the 'kind' attribute was set.

Returns
true if the 'kind' attribute was set.

◆ has_localizations()

bool google_youtube_api::Playlist::has_localizations ( ) const
inline

Determine if the 'localizations' attribute was set.

Returns
true if the 'localizations' attribute was set.

◆ has_player()

bool google_youtube_api::Playlist::has_player ( ) const
inline

Determine if the 'player' attribute was set.

Returns
true if the 'player' attribute was set.

◆ has_snippet()

bool google_youtube_api::Playlist::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::Playlist::has_status ( ) const
inline

Determine if the 'status' attribute was set.

Returns
true if the 'status' attribute was set.

◆ mutable_contentDetails()

PlaylistContentDetails google_youtube_api::Playlist::mutable_contentDetails ( )

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

The contentDetails object contains information like video count.

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

◆ mutable_localizations()

client::JsonCppAssociativeArray<PlaylistLocalization > google_youtube_api::Playlist::mutable_localizations ( )

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

Localizations for different languages.

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

◆ mutable_player()

PlaylistPlayer google_youtube_api::Playlist::mutable_player ( )

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

The player object contains information that you would use to play the playlist in an embedded player.

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

◆ mutable_snippet()

PlaylistSnippet google_youtube_api::Playlist::mutable_snippet ( )

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

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

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

◆ mutable_status()

PlaylistStatus google_youtube_api::Playlist::mutable_status ( )

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

The status object contains status information for the playlist.

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

◆ New()

Playlist * google_youtube_api::Playlist::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_etag()

void google_youtube_api::Playlist::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::Playlist::set_id ( const StringPiece &  value)
inline

Change the 'id' attribute.

The ID that YouTube uses to uniquely identify the playlist.

Parameters
[in]valueThe new value.

◆ set_kind()

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

Change the 'kind' attribute.

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

Parameters
[in]valueThe new value.

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