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

#include <search_result_snippet.h>

Inheritance diagram for google_youtube_api::SearchResultSnippet:

Public Member Functions

 SearchResultSnippet (const Json::Value &storage)
 
 SearchResultSnippet (Json::Value *storage)
 
virtual ~SearchResultSnippet ()
 
const StringPiece GetTypeName () const
 
bool has_channel_id () const
 
void clear_channel_id ()
 
const StringPiece get_channel_id () const
 
void set_channel_id (const StringPiece &value)
 
bool has_channel_title () const
 
void clear_channel_title ()
 
const StringPiece get_channel_title () const
 
void set_channel_title (const StringPiece &value)
 
bool has_description () const
 
void clear_description ()
 
const StringPiece get_description () const
 
void set_description (const StringPiece &value)
 
bool has_live_broadcast_content () const
 
void clear_live_broadcast_content ()
 
const StringPiece get_live_broadcast_content () const
 
void set_live_broadcast_content (const StringPiece &value)
 
bool has_published_at () const
 
void clear_published_at ()
 
client::DateTime get_published_at () const
 
void set_published_at (client::DateTime value)
 
bool has_thumbnails () const
 
void clear_thumbnails ()
 
const ThumbnailDetails get_thumbnails () const
 
ThumbnailDetails mutable_thumbnails ()
 
bool has_title () const
 
void clear_title ()
 
const StringPiece get_title () const
 
void set_title (const StringPiece &value)
 

Static Public Member Functions

static SearchResultSnippetNew ()
 

Detailed Description

Basic details about a search result, including title, description and thumbnails of the item referenced by the search result.

Constructor & Destructor Documentation

◆ SearchResultSnippet() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ SearchResultSnippet() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~SearchResultSnippet()

google_youtube_api::SearchResultSnippet::~SearchResultSnippet ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_channel_id()

void google_youtube_api::SearchResultSnippet::clear_channel_id ( )
inline

Clears the 'channelId' attribute.

◆ clear_channel_title()

void google_youtube_api::SearchResultSnippet::clear_channel_title ( )
inline

Clears the 'channelTitle' attribute.

◆ clear_description()

void google_youtube_api::SearchResultSnippet::clear_description ( )
inline

Clears the 'description' attribute.

◆ clear_live_broadcast_content()

void google_youtube_api::SearchResultSnippet::clear_live_broadcast_content ( )
inline

Clears the 'liveBroadcastContent' attribute.

◆ clear_published_at()

void google_youtube_api::SearchResultSnippet::clear_published_at ( )
inline

Clears the 'publishedAt' attribute.

◆ clear_thumbnails()

void google_youtube_api::SearchResultSnippet::clear_thumbnails ( )
inline

Clears the 'thumbnails' attribute.

◆ clear_title()

void google_youtube_api::SearchResultSnippet::clear_title ( )
inline

Clears the 'title' attribute.

◆ get_channel_id()

const StringPiece google_youtube_api::SearchResultSnippet::get_channel_id ( ) const
inline

Get the value of the 'channelId' attribute.

◆ get_channel_title()

const StringPiece google_youtube_api::SearchResultSnippet::get_channel_title ( ) const
inline

Get the value of the 'channelTitle' attribute.

◆ get_description()

const StringPiece google_youtube_api::SearchResultSnippet::get_description ( ) const
inline

Get the value of the 'description' attribute.

◆ get_live_broadcast_content()

const StringPiece google_youtube_api::SearchResultSnippet::get_live_broadcast_content ( ) const
inline

Get the value of the 'liveBroadcastContent' attribute.

◆ get_published_at()

client::DateTime google_youtube_api::SearchResultSnippet::get_published_at ( ) const
inline

Get the value of the 'publishedAt' attribute.

◆ get_thumbnails()

const ThumbnailDetails google_youtube_api::SearchResultSnippet::get_thumbnails ( ) const

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

◆ get_title()

const StringPiece google_youtube_api::SearchResultSnippet::get_title ( ) const
inline

Get the value of the 'title' attribute.

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_youtube_api::SearchResultSnippet

◆ has_channel_id()

bool google_youtube_api::SearchResultSnippet::has_channel_id ( ) const
inline

Determine if the 'channelId' attribute was set.

Returns
true if the 'channelId' attribute was set.

◆ has_channel_title()

bool google_youtube_api::SearchResultSnippet::has_channel_title ( ) const
inline

Determine if the 'channelTitle' attribute was set.

Returns
true if the 'channelTitle' attribute was set.

◆ has_description()

bool google_youtube_api::SearchResultSnippet::has_description ( ) const
inline

Determine if the 'description' attribute was set.

Returns
true if the 'description' attribute was set.

◆ has_live_broadcast_content()

bool google_youtube_api::SearchResultSnippet::has_live_broadcast_content ( ) const
inline

Determine if the 'liveBroadcastContent' attribute was set.

Returns
true if the 'liveBroadcastContent' attribute was set.

◆ has_published_at()

bool google_youtube_api::SearchResultSnippet::has_published_at ( ) const
inline

Determine if the 'publishedAt' attribute was set.

Returns
true if the 'publishedAt' attribute was set.

◆ has_thumbnails()

bool google_youtube_api::SearchResultSnippet::has_thumbnails ( ) const
inline

Determine if the 'thumbnails' attribute was set.

Returns
true if the 'thumbnails' attribute was set.

◆ has_title()

bool google_youtube_api::SearchResultSnippet::has_title ( ) const
inline

Determine if the 'title' attribute was set.

Returns
true if the 'title' attribute was set.

◆ mutable_thumbnails()

ThumbnailDetails google_youtube_api::SearchResultSnippet::mutable_thumbnails ( )

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

A map of thumbnail images associated with the search result. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.

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

◆ New()

SearchResultSnippet * google_youtube_api::SearchResultSnippet::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_channel_id()

void google_youtube_api::SearchResultSnippet::set_channel_id ( const StringPiece &  value)
inline

Change the 'channelId' attribute.

The value that YouTube uses to uniquely identify the channel that published the resource that the search result identifies.

Parameters
[in]valueThe new value.

◆ set_channel_title()

void google_youtube_api::SearchResultSnippet::set_channel_title ( const StringPiece &  value)
inline

Change the 'channelTitle' attribute.

The title of the channel that published the resource that the search result identifies.

Parameters
[in]valueThe new value.

◆ set_description()

void google_youtube_api::SearchResultSnippet::set_description ( const StringPiece &  value)
inline

Change the 'description' attribute.

A description of the search result.

Parameters
[in]valueThe new value.

◆ set_live_broadcast_content()

void google_youtube_api::SearchResultSnippet::set_live_broadcast_content ( const StringPiece &  value)
inline

Change the 'liveBroadcastContent' attribute.

It indicates if the resource (video or channel) has upcoming/active live broadcast content. Or it's "none" if there is not any upcoming/active live broadcasts.

Parameters
[in]valueThe new value.

◆ set_published_at()

void google_youtube_api::SearchResultSnippet::set_published_at ( client::DateTime  value)
inline

Change the 'publishedAt' attribute.

The creation date and time of the resource that the search result identifies. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

Parameters
[in]valueThe new value.

◆ set_title()

void google_youtube_api::SearchResultSnippet::set_title ( const StringPiece &  value)
inline

Change the 'title' attribute.

The title of the search result.

Parameters
[in]valueThe new value.

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