#include <comment_snippet.h>

Inheritance diagram for google_youtube_api::CommentSnippet:

Public Member Functions
	CommentSnippet (const Json::Value &storage)

	CommentSnippet (Json::Value *storage)

virtual	~CommentSnippet ()

const StringPiece	GetTypeName () const

bool	has_author_channel_id () const

void	clear_author_channel_id ()

const client::JsonCppData	get_author_channel_id () const

client::JsonCppData	mutable_authorChannelId ()

bool	has_author_channel_url () const

void	clear_author_channel_url ()

const StringPiece	get_author_channel_url () const

void	set_author_channel_url (const StringPiece &value)

bool	has_author_display_name () const

void	clear_author_display_name ()

const StringPiece	get_author_display_name () const

void	set_author_display_name (const StringPiece &value)

bool	has_author_profile_image_url () const

void	clear_author_profile_image_url ()

const StringPiece	get_author_profile_image_url () const

void	set_author_profile_image_url (const StringPiece &value)

bool	has_can_rate () const

void	clear_can_rate ()

bool	get_can_rate () const

void	set_can_rate (bool value)

bool	has_channel_id () const

void	clear_channel_id ()

const StringPiece	get_channel_id () const

void	set_channel_id (const StringPiece &value)

bool	has_like_count () const

void	clear_like_count ()

uint32	get_like_count () const

void	set_like_count (uint32 value)

bool	has_moderation_status () const

void	clear_moderation_status ()

const StringPiece	get_moderation_status () const

void	set_moderation_status (const StringPiece &value)

bool	has_parent_id () const

void	clear_parent_id ()

const StringPiece	get_parent_id () const

void	set_parent_id (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_text_display () const

void	clear_text_display ()

const StringPiece	get_text_display () const

void	set_text_display (const StringPiece &value)

bool	has_text_original () const

void	clear_text_original ()

const StringPiece	get_text_original () const

void	set_text_original (const StringPiece &value)

bool	has_updated_at () const

void	clear_updated_at ()

client::DateTime	get_updated_at () const

void	set_updated_at (client::DateTime 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_viewer_rating () const

void	clear_viewer_rating ()

const StringPiece	get_viewer_rating () const

void	set_viewer_rating (const StringPiece &value)

Static Public Member Functions
static CommentSnippet *	New ()

Detailed Description

Basic details about a comment, such as its author and text.

Constructor & Destructor Documentation

◆ CommentSnippet() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ CommentSnippet() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ ~CommentSnippet()

google_youtube_api::CommentSnippet::~CommentSnippet ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_author_channel_id()

void google_youtube_api::CommentSnippet::clear_author_channel_id ( )

inline

Clears the 'authorChannelId' attribute.

◆ clear_author_channel_url()

void google_youtube_api::CommentSnippet::clear_author_channel_url ( )

inline

Clears the 'authorChannelUrl' attribute.

◆ clear_author_display_name()

void google_youtube_api::CommentSnippet::clear_author_display_name ( )

inline

Clears the 'authorDisplayName' attribute.

◆ clear_author_profile_image_url()

void google_youtube_api::CommentSnippet::clear_author_profile_image_url ( )

inline

Clears the 'authorProfileImageUrl' attribute.

◆ clear_can_rate()

void google_youtube_api::CommentSnippet::clear_can_rate ( )

inline

Clears the 'canRate' attribute.

◆ clear_channel_id()

void google_youtube_api::CommentSnippet::clear_channel_id ( )

inline

Clears the 'channelId' attribute.

◆ clear_like_count()

void google_youtube_api::CommentSnippet::clear_like_count ( )

inline

Clears the 'likeCount' attribute.

◆ clear_moderation_status()

void google_youtube_api::CommentSnippet::clear_moderation_status ( )

inline

Clears the 'moderationStatus' attribute.

◆ clear_parent_id()

void google_youtube_api::CommentSnippet::clear_parent_id ( )

inline

Clears the 'parentId' attribute.

◆ clear_published_at()

void google_youtube_api::CommentSnippet::clear_published_at ( )

inline

Clears the 'publishedAt' attribute.

◆ clear_text_display()

void google_youtube_api::CommentSnippet::clear_text_display ( )

inline

Clears the 'textDisplay' attribute.

◆ clear_text_original()

void google_youtube_api::CommentSnippet::clear_text_original ( )

inline

Clears the 'textOriginal' attribute.

◆ clear_updated_at()

void google_youtube_api::CommentSnippet::clear_updated_at ( )

inline

Clears the 'updatedAt' attribute.

◆ clear_video_id()

void google_youtube_api::CommentSnippet::clear_video_id ( )

inline

Clears the 'videoId' attribute.

◆ clear_viewer_rating()

void google_youtube_api::CommentSnippet::clear_viewer_rating ( )

inline

Clears the 'viewerRating' attribute.

◆ get_author_channel_id()

const client::JsonCppData google_youtube_api::CommentSnippet::get_author_channel_id ( ) const

inline

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

◆ get_author_channel_url()

const StringPiece google_youtube_api::CommentSnippet::get_author_channel_url ( ) const

inline

Get the value of the 'authorChannelUrl' attribute.

◆ get_author_display_name()

const StringPiece google_youtube_api::CommentSnippet::get_author_display_name ( ) const

inline

Get the value of the 'authorDisplayName' attribute.

◆ get_author_profile_image_url()

const StringPiece google_youtube_api::CommentSnippet::get_author_profile_image_url ( ) const

inline

Get the value of the 'authorProfileImageUrl' attribute.

◆ get_can_rate()

bool google_youtube_api::CommentSnippet::get_can_rate ( ) const

inline

Get the value of the 'canRate' attribute.

◆ get_channel_id()

const StringPiece google_youtube_api::CommentSnippet::get_channel_id ( ) const

inline

Get the value of the 'channelId' attribute.

◆ get_like_count()

uint32 google_youtube_api::CommentSnippet::get_like_count ( ) const

inline

Get the value of the 'likeCount' attribute.

◆ get_moderation_status()

const StringPiece google_youtube_api::CommentSnippet::get_moderation_status ( ) const

inline

Get the value of the 'moderationStatus' attribute.

◆ get_parent_id()

const StringPiece google_youtube_api::CommentSnippet::get_parent_id ( ) const

inline

Get the value of the 'parentId' attribute.

◆ get_published_at()

client::DateTime google_youtube_api::CommentSnippet::get_published_at ( ) const

inline

Get the value of the 'publishedAt' attribute.

◆ get_text_display()

const StringPiece google_youtube_api::CommentSnippet::get_text_display ( ) const

inline

Get the value of the 'textDisplay' attribute.

◆ get_text_original()

const StringPiece google_youtube_api::CommentSnippet::get_text_original ( ) const

inline

Get the value of the 'textOriginal' attribute.

◆ get_updated_at()

client::DateTime google_youtube_api::CommentSnippet::get_updated_at ( ) const

inline

Get the value of the 'updatedAt' attribute.

◆ get_video_id()

const StringPiece google_youtube_api::CommentSnippet::get_video_id ( ) const

inline

Get the value of the 'videoId' attribute.

◆ get_viewer_rating()

const StringPiece google_youtube_api::CommentSnippet::get_viewer_rating ( ) const

inline

Get the value of the 'viewerRating' attribute.

◆ GetTypeName()

const StringPiece google_youtube_api::CommentSnippet::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_youtube_api::CommentSnippet

◆ has_author_channel_id()

bool google_youtube_api::CommentSnippet::has_author_channel_id ( ) const

inline

Determine if the 'authorChannelId' attribute was set.

Returns: true if the 'authorChannelId' attribute was set.

◆ has_author_channel_url()

bool google_youtube_api::CommentSnippet::has_author_channel_url ( ) const

inline

Determine if the 'authorChannelUrl' attribute was set.

Returns: true if the 'authorChannelUrl' attribute was set.

◆ has_author_display_name()

bool google_youtube_api::CommentSnippet::has_author_display_name ( ) const

inline

Determine if the 'authorDisplayName' attribute was set.

Returns: true if the 'authorDisplayName' attribute was set.

◆ has_author_profile_image_url()

bool google_youtube_api::CommentSnippet::has_author_profile_image_url ( ) const

inline

Determine if the 'authorProfileImageUrl' attribute was set.

Returns: true if the 'authorProfileImageUrl' attribute was set.

◆ has_can_rate()

bool google_youtube_api::CommentSnippet::has_can_rate ( ) const

inline

Determine if the 'canRate' attribute was set.

Returns: true if the 'canRate' attribute was set.

◆ has_channel_id()

bool google_youtube_api::CommentSnippet::has_channel_id ( ) const

inline

Determine if the 'channelId' attribute was set.

Returns: true if the 'channelId' attribute was set.

◆ has_like_count()

bool google_youtube_api::CommentSnippet::has_like_count ( ) const

inline

Determine if the 'likeCount' attribute was set.

Returns: true if the 'likeCount' attribute was set.

◆ has_moderation_status()

bool google_youtube_api::CommentSnippet::has_moderation_status ( ) const

inline

Determine if the 'moderationStatus' attribute was set.

Returns: true if the 'moderationStatus' attribute was set.

◆ has_parent_id()

bool google_youtube_api::CommentSnippet::has_parent_id ( ) const

inline

Determine if the 'parentId' attribute was set.

Returns: true if the 'parentId' attribute was set.

◆ has_published_at()

bool google_youtube_api::CommentSnippet::has_published_at ( ) const

inline

Determine if the 'publishedAt' attribute was set.

Returns: true if the 'publishedAt' attribute was set.

◆ has_text_display()

bool google_youtube_api::CommentSnippet::has_text_display ( ) const

inline

Determine if the 'textDisplay' attribute was set.

Returns: true if the 'textDisplay' attribute was set.

◆ has_text_original()

bool google_youtube_api::CommentSnippet::has_text_original ( ) const

inline

Determine if the 'textOriginal' attribute was set.

Returns: true if the 'textOriginal' attribute was set.

◆ has_updated_at()

bool google_youtube_api::CommentSnippet::has_updated_at ( ) const

inline

Determine if the 'updatedAt' attribute was set.

Returns: true if the 'updatedAt' attribute was set.

◆ has_video_id()

bool google_youtube_api::CommentSnippet::has_video_id ( ) const

inline

Determine if the 'videoId' attribute was set.

Returns: true if the 'videoId' attribute was set.

◆ has_viewer_rating()

bool google_youtube_api::CommentSnippet::has_viewer_rating ( ) const

inline

Determine if the 'viewerRating' attribute was set.

Returns: true if the 'viewerRating' attribute was set.

◆ mutable_authorChannelId()

client::JsonCppData google_youtube_api::CommentSnippet::mutable_authorChannelId ( )

inline

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

The id of the author's YouTube channel, if any.

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

◆ New()

CommentSnippet * google_youtube_api::CommentSnippet::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_author_channel_url()

void google_youtube_api::CommentSnippet::set_author_channel_url ( const StringPiece & value )

inline

Change the 'authorChannelUrl' attribute.

Link to the author's YouTube channel, if any.

Parameters

[in] value The new value.

◆ set_author_display_name()

void google_youtube_api::CommentSnippet::set_author_display_name ( const StringPiece & value )

inline

Change the 'authorDisplayName' attribute.

The name of the user who posted the comment.

Parameters

[in] value The new value.

◆ set_author_profile_image_url()

void google_youtube_api::CommentSnippet::set_author_profile_image_url ( const StringPiece & value )

inline

Change the 'authorProfileImageUrl' attribute.

The URL for the avatar of the user who posted the comment.

Parameters

[in] value The new value.

◆ set_can_rate()

void google_youtube_api::CommentSnippet::set_can_rate ( bool value )

inline

Change the 'canRate' attribute.

Whether the current viewer can rate this comment.

Parameters

[in] value The new value.

◆ set_channel_id()

void google_youtube_api::CommentSnippet::set_channel_id ( const StringPiece & value )

inline

Change the 'channelId' attribute.

The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.

Parameters

[in] value The new value.

◆ set_like_count()

void google_youtube_api::CommentSnippet::set_like_count ( uint32 value )

inline

Change the 'likeCount' attribute.

The total number of likes this comment has received.

Parameters

[in] value The new value.

◆ set_moderation_status()

void google_youtube_api::CommentSnippet::set_moderation_status ( const StringPiece & value )

inline

Change the 'moderationStatus' attribute.

The comment's moderation status. Will not be set if the comments were requested through the id filter.

Parameters

[in] value The new value.

◆ set_parent_id()

void google_youtube_api::CommentSnippet::set_parent_id ( const StringPiece & value )

inline

Change the 'parentId' attribute.

The unique id of the parent comment, only set for replies.

Parameters

[in] value The new value.

◆ set_published_at()

void google_youtube_api::CommentSnippet::set_published_at ( client::DateTime value )

inline

Change the 'publishedAt' attribute.

The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

Parameters

[in] value The new value.

◆ set_text_display()

void google_youtube_api::CommentSnippet::set_text_display ( const StringPiece & value )

inline

Change the 'textDisplay' attribute.

The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.

Parameters

[in] value The new value.

◆ set_text_original()

void google_youtube_api::CommentSnippet::set_text_original ( const StringPiece & value )

inline

Change the 'textOriginal' attribute.

The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.

Parameters

[in] value The new value.

◆ set_updated_at()

void google_youtube_api::CommentSnippet::set_updated_at ( client::DateTime value )

inline

Change the 'updatedAt' attribute.

The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

Parameters

[in] value The new value.

◆ set_video_id()

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

inline

Change the 'videoId' attribute.

The ID of the video the comment refers to, if any.

Parameters

[in] value The new value.

◆ set_viewer_rating()

void google_youtube_api::CommentSnippet::set_viewer_rating ( const StringPiece & value )

inline

Change the 'viewerRating' attribute.

The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.

Parameters

[in] value The new value.

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

google/youtube_api/comment_snippet.h
google/youtube_api/comment_snippet.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CommentSnippet() [1/2]

◆ CommentSnippet() [2/2]

◆ ~CommentSnippet()

Member Function Documentation

◆ clear_author_channel_id()

◆ clear_author_channel_url()

◆ clear_author_display_name()

◆ clear_author_profile_image_url()

◆ clear_can_rate()

◆ clear_channel_id()

◆ clear_like_count()

◆ clear_moderation_status()

◆ clear_parent_id()

◆ clear_published_at()

◆ clear_text_display()

◆ clear_text_original()

◆ clear_updated_at()

◆ clear_video_id()

◆ clear_viewer_rating()

◆ get_author_channel_id()

◆ get_author_channel_url()

◆ get_author_display_name()

◆ get_author_profile_image_url()

◆ get_can_rate()

◆ get_channel_id()

◆ get_like_count()

◆ get_moderation_status()

◆ get_parent_id()

◆ get_published_at()

◆ get_text_display()

◆ get_text_original()

◆ get_updated_at()

◆ get_video_id()

◆ get_viewer_rating()

◆ GetTypeName()

◆ has_author_channel_id()

◆ has_author_channel_url()

◆ has_author_display_name()

◆ has_author_profile_image_url()

◆ has_can_rate()

◆ has_channel_id()

◆ has_like_count()

◆ has_moderation_status()

◆ has_parent_id()

◆ has_published_at()

◆ has_text_display()

◆ has_text_original()

◆ has_updated_at()

◆ has_video_id()

◆ has_viewer_rating()

◆ mutable_authorChannelId()

◆ New()

◆ set_author_channel_url()

◆ set_author_display_name()

◆ set_author_profile_image_url()

◆ set_can_rate()

◆ set_channel_id()

◆ set_like_count()

◆ set_moderation_status()

◆ set_parent_id()

◆ set_published_at()

◆ set_text_display()

◆ set_text_original()

◆ set_updated_at()

◆ set_video_id()

◆ set_viewer_rating()