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

#include <live_chat_message_snippet.h>

Inheritance diagram for google_youtube_api::LiveChatMessageSnippet:

Public Member Functions

 LiveChatMessageSnippet (const Json::Value &storage)
 
 LiveChatMessageSnippet (Json::Value *storage)
 
virtual ~LiveChatMessageSnippet ()
 
const StringPiece GetTypeName () const
 
bool has_author_channel_id () const
 
void clear_author_channel_id ()
 
const StringPiece get_author_channel_id () const
 
void set_author_channel_id (const StringPiece &value)
 
bool has_display_message () const
 
void clear_display_message ()
 
const StringPiece get_display_message () const
 
void set_display_message (const StringPiece &value)
 
bool has_fan_funding_event_details () const
 
void clear_fan_funding_event_details ()
 
const LiveChatFanFundingEventDetails get_fan_funding_event_details () const
 
LiveChatFanFundingEventDetails mutable_fanFundingEventDetails ()
 
bool has_has_display_content () const
 
void clear_has_display_content ()
 
bool get_has_display_content () const
 
void set_has_display_content (bool value)
 
bool has_live_chat_id () const
 
void clear_live_chat_id ()
 
const StringPiece get_live_chat_id () const
 
void set_live_chat_id (const StringPiece &value)
 
bool has_message_deleted_details () const
 
void clear_message_deleted_details ()
 
const LiveChatMessageDeletedDetails get_message_deleted_details () const
 
LiveChatMessageDeletedDetails mutable_messageDeletedDetails ()
 
bool has_message_retracted_details () const
 
void clear_message_retracted_details ()
 
const LiveChatMessageRetractedDetails get_message_retracted_details () const
 
LiveChatMessageRetractedDetails mutable_messageRetractedDetails ()
 
bool has_poll_closed_details () const
 
void clear_poll_closed_details ()
 
const LiveChatPollClosedDetails get_poll_closed_details () const
 
LiveChatPollClosedDetails mutable_pollClosedDetails ()
 
bool has_poll_edited_details () const
 
void clear_poll_edited_details ()
 
const LiveChatPollEditedDetails get_poll_edited_details () const
 
LiveChatPollEditedDetails mutable_pollEditedDetails ()
 
bool has_poll_opened_details () const
 
void clear_poll_opened_details ()
 
const LiveChatPollOpenedDetails get_poll_opened_details () const
 
LiveChatPollOpenedDetails mutable_pollOpenedDetails ()
 
bool has_poll_voted_details () const
 
void clear_poll_voted_details ()
 
const LiveChatPollVotedDetails get_poll_voted_details () const
 
LiveChatPollVotedDetails mutable_pollVotedDetails ()
 
bool has_published_at () const
 
void clear_published_at ()
 
client::DateTime get_published_at () const
 
void set_published_at (client::DateTime value)
 
bool has_super_chat_details () const
 
void clear_super_chat_details ()
 
const LiveChatSuperChatDetails get_super_chat_details () const
 
LiveChatSuperChatDetails mutable_superChatDetails ()
 
bool has_super_sticker_details () const
 
void clear_super_sticker_details ()
 
const LiveChatSuperStickerDetails get_super_sticker_details () const
 
LiveChatSuperStickerDetails mutable_superStickerDetails ()
 
bool has_text_message_details () const
 
void clear_text_message_details ()
 
const LiveChatTextMessageDetails get_text_message_details () const
 
LiveChatTextMessageDetails mutable_textMessageDetails ()
 
bool has_type () const
 
void clear_type ()
 
const StringPiece get_type () const
 
void set_type (const StringPiece &value)
 
bool has_user_banned_details () const
 
void clear_user_banned_details ()
 
const LiveChatUserBannedMessageDetails get_user_banned_details () const
 
LiveChatUserBannedMessageDetails mutable_userBannedDetails ()
 

Static Public Member Functions

static LiveChatMessageSnippetNew ()
 

Detailed Description

No description provided.

Constructor & Destructor Documentation

◆ LiveChatMessageSnippet() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ LiveChatMessageSnippet() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~LiveChatMessageSnippet()

google_youtube_api::LiveChatMessageSnippet::~LiveChatMessageSnippet ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_author_channel_id()

void google_youtube_api::LiveChatMessageSnippet::clear_author_channel_id ( )
inline

Clears the 'authorChannelId' attribute.

◆ clear_display_message()

void google_youtube_api::LiveChatMessageSnippet::clear_display_message ( )
inline

Clears the 'displayMessage' attribute.

◆ clear_fan_funding_event_details()

void google_youtube_api::LiveChatMessageSnippet::clear_fan_funding_event_details ( )
inline

Clears the 'fanFundingEventDetails' attribute.

◆ clear_has_display_content()

void google_youtube_api::LiveChatMessageSnippet::clear_has_display_content ( )
inline

Clears the 'hasDisplayContent' attribute.

◆ clear_live_chat_id()

void google_youtube_api::LiveChatMessageSnippet::clear_live_chat_id ( )
inline

Clears the 'liveChatId' attribute.

◆ clear_message_deleted_details()

void google_youtube_api::LiveChatMessageSnippet::clear_message_deleted_details ( )
inline

Clears the 'messageDeletedDetails' attribute.

◆ clear_message_retracted_details()

void google_youtube_api::LiveChatMessageSnippet::clear_message_retracted_details ( )
inline

Clears the 'messageRetractedDetails' attribute.

◆ clear_poll_closed_details()

void google_youtube_api::LiveChatMessageSnippet::clear_poll_closed_details ( )
inline

Clears the 'pollClosedDetails' attribute.

◆ clear_poll_edited_details()

void google_youtube_api::LiveChatMessageSnippet::clear_poll_edited_details ( )
inline

Clears the 'pollEditedDetails' attribute.

◆ clear_poll_opened_details()

void google_youtube_api::LiveChatMessageSnippet::clear_poll_opened_details ( )
inline

Clears the 'pollOpenedDetails' attribute.

◆ clear_poll_voted_details()

void google_youtube_api::LiveChatMessageSnippet::clear_poll_voted_details ( )
inline

Clears the 'pollVotedDetails' attribute.

◆ clear_published_at()

void google_youtube_api::LiveChatMessageSnippet::clear_published_at ( )
inline

Clears the 'publishedAt' attribute.

◆ clear_super_chat_details()

void google_youtube_api::LiveChatMessageSnippet::clear_super_chat_details ( )
inline

Clears the 'superChatDetails' attribute.

◆ clear_super_sticker_details()

void google_youtube_api::LiveChatMessageSnippet::clear_super_sticker_details ( )
inline

Clears the 'superStickerDetails' attribute.

◆ clear_text_message_details()

void google_youtube_api::LiveChatMessageSnippet::clear_text_message_details ( )
inline

Clears the 'textMessageDetails' attribute.

◆ clear_type()

void google_youtube_api::LiveChatMessageSnippet::clear_type ( )
inline

Clears the 'type' attribute.

◆ clear_user_banned_details()

void google_youtube_api::LiveChatMessageSnippet::clear_user_banned_details ( )
inline

Clears the 'userBannedDetails' attribute.

◆ get_author_channel_id()

const StringPiece google_youtube_api::LiveChatMessageSnippet::get_author_channel_id ( ) const
inline

Get the value of the 'authorChannelId' attribute.

◆ get_display_message()

const StringPiece google_youtube_api::LiveChatMessageSnippet::get_display_message ( ) const
inline

Get the value of the 'displayMessage' attribute.

◆ get_fan_funding_event_details()

const LiveChatFanFundingEventDetails google_youtube_api::LiveChatMessageSnippet::get_fan_funding_event_details ( ) const

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

◆ get_has_display_content()

bool google_youtube_api::LiveChatMessageSnippet::get_has_display_content ( ) const
inline

Get the value of the 'hasDisplayContent' attribute.

◆ get_live_chat_id()

const StringPiece google_youtube_api::LiveChatMessageSnippet::get_live_chat_id ( ) const
inline

Get the value of the 'liveChatId' attribute.

◆ get_message_deleted_details()

const LiveChatMessageDeletedDetails google_youtube_api::LiveChatMessageSnippet::get_message_deleted_details ( ) const

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

◆ get_message_retracted_details()

const LiveChatMessageRetractedDetails google_youtube_api::LiveChatMessageSnippet::get_message_retracted_details ( ) const

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

◆ get_poll_closed_details()

const LiveChatPollClosedDetails google_youtube_api::LiveChatMessageSnippet::get_poll_closed_details ( ) const

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

◆ get_poll_edited_details()

const LiveChatPollEditedDetails google_youtube_api::LiveChatMessageSnippet::get_poll_edited_details ( ) const

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

◆ get_poll_opened_details()

const LiveChatPollOpenedDetails google_youtube_api::LiveChatMessageSnippet::get_poll_opened_details ( ) const

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

◆ get_poll_voted_details()

const LiveChatPollVotedDetails google_youtube_api::LiveChatMessageSnippet::get_poll_voted_details ( ) const

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

◆ get_published_at()

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

Get the value of the 'publishedAt' attribute.

◆ get_super_chat_details()

const LiveChatSuperChatDetails google_youtube_api::LiveChatMessageSnippet::get_super_chat_details ( ) const

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

◆ get_super_sticker_details()

const LiveChatSuperStickerDetails google_youtube_api::LiveChatMessageSnippet::get_super_sticker_details ( ) const

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

◆ get_text_message_details()

const LiveChatTextMessageDetails google_youtube_api::LiveChatMessageSnippet::get_text_message_details ( ) const

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

◆ get_type()

const StringPiece google_youtube_api::LiveChatMessageSnippet::get_type ( ) const
inline

Get the value of the 'type' attribute.

◆ get_user_banned_details()

const LiveChatUserBannedMessageDetails google_youtube_api::LiveChatMessageSnippet::get_user_banned_details ( ) const

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

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_youtube_api::LiveChatMessageSnippet

◆ has_author_channel_id()

bool google_youtube_api::LiveChatMessageSnippet::has_author_channel_id ( ) const
inline

Determine if the 'authorChannelId' attribute was set.

Returns
true if the 'authorChannelId' attribute was set.

◆ has_display_message()

bool google_youtube_api::LiveChatMessageSnippet::has_display_message ( ) const
inline

Determine if the 'displayMessage' attribute was set.

Returns
true if the 'displayMessage' attribute was set.

◆ has_fan_funding_event_details()

bool google_youtube_api::LiveChatMessageSnippet::has_fan_funding_event_details ( ) const
inline

Determine if the 'fanFundingEventDetails' attribute was set.

Returns
true if the 'fanFundingEventDetails' attribute was set.

◆ has_has_display_content()

bool google_youtube_api::LiveChatMessageSnippet::has_has_display_content ( ) const
inline

Determine if the 'hasDisplayContent' attribute was set.

Returns
true if the 'hasDisplayContent' attribute was set.

◆ has_live_chat_id()

bool google_youtube_api::LiveChatMessageSnippet::has_live_chat_id ( ) const
inline

Determine if the 'liveChatId' attribute was set.

Returns
true if the 'liveChatId' attribute was set.

◆ has_message_deleted_details()

bool google_youtube_api::LiveChatMessageSnippet::has_message_deleted_details ( ) const
inline

Determine if the 'messageDeletedDetails' attribute was set.

Returns
true if the 'messageDeletedDetails' attribute was set.

◆ has_message_retracted_details()

bool google_youtube_api::LiveChatMessageSnippet::has_message_retracted_details ( ) const
inline

Determine if the 'messageRetractedDetails' attribute was set.

Returns
true if the 'messageRetractedDetails' attribute was set.

◆ has_poll_closed_details()

bool google_youtube_api::LiveChatMessageSnippet::has_poll_closed_details ( ) const
inline

Determine if the 'pollClosedDetails' attribute was set.

Returns
true if the 'pollClosedDetails' attribute was set.

◆ has_poll_edited_details()

bool google_youtube_api::LiveChatMessageSnippet::has_poll_edited_details ( ) const
inline

Determine if the 'pollEditedDetails' attribute was set.

Returns
true if the 'pollEditedDetails' attribute was set.

◆ has_poll_opened_details()

bool google_youtube_api::LiveChatMessageSnippet::has_poll_opened_details ( ) const
inline

Determine if the 'pollOpenedDetails' attribute was set.

Returns
true if the 'pollOpenedDetails' attribute was set.

◆ has_poll_voted_details()

bool google_youtube_api::LiveChatMessageSnippet::has_poll_voted_details ( ) const
inline

Determine if the 'pollVotedDetails' attribute was set.

Returns
true if the 'pollVotedDetails' attribute was set.

◆ has_published_at()

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

Determine if the 'publishedAt' attribute was set.

Returns
true if the 'publishedAt' attribute was set.

◆ has_super_chat_details()

bool google_youtube_api::LiveChatMessageSnippet::has_super_chat_details ( ) const
inline

Determine if the 'superChatDetails' attribute was set.

Returns
true if the 'superChatDetails' attribute was set.

◆ has_super_sticker_details()

bool google_youtube_api::LiveChatMessageSnippet::has_super_sticker_details ( ) const
inline

Determine if the 'superStickerDetails' attribute was set.

Returns
true if the 'superStickerDetails' attribute was set.

◆ has_text_message_details()

bool google_youtube_api::LiveChatMessageSnippet::has_text_message_details ( ) const
inline

Determine if the 'textMessageDetails' attribute was set.

Returns
true if the 'textMessageDetails' attribute was set.

◆ has_type()

bool google_youtube_api::LiveChatMessageSnippet::has_type ( ) const
inline

Determine if the 'type' attribute was set.

Returns
true if the 'type' attribute was set.

◆ has_user_banned_details()

bool google_youtube_api::LiveChatMessageSnippet::has_user_banned_details ( ) const
inline

Determine if the 'userBannedDetails' attribute was set.

Returns
true if the 'userBannedDetails' attribute was set.

◆ mutable_fanFundingEventDetails()

LiveChatFanFundingEventDetails google_youtube_api::LiveChatMessageSnippet::mutable_fanFundingEventDetails ( )

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

Details about the funding event, this is only set if the type is 'fanFundingEvent'.

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

◆ mutable_messageDeletedDetails()

LiveChatMessageDeletedDetails google_youtube_api::LiveChatMessageSnippet::mutable_messageDeletedDetails ( )

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

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

◆ mutable_messageRetractedDetails()

LiveChatMessageRetractedDetails google_youtube_api::LiveChatMessageSnippet::mutable_messageRetractedDetails ( )

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

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

◆ mutable_pollClosedDetails()

LiveChatPollClosedDetails google_youtube_api::LiveChatMessageSnippet::mutable_pollClosedDetails ( )

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

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

◆ mutable_pollEditedDetails()

LiveChatPollEditedDetails google_youtube_api::LiveChatMessageSnippet::mutable_pollEditedDetails ( )

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

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

◆ mutable_pollOpenedDetails()

LiveChatPollOpenedDetails google_youtube_api::LiveChatMessageSnippet::mutable_pollOpenedDetails ( )

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

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

◆ mutable_pollVotedDetails()

LiveChatPollVotedDetails google_youtube_api::LiveChatMessageSnippet::mutable_pollVotedDetails ( )

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

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

◆ mutable_superChatDetails()

LiveChatSuperChatDetails google_youtube_api::LiveChatMessageSnippet::mutable_superChatDetails ( )

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

Details about the Super Chat event, this is only set if the type is 'superChatEvent'.

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

◆ mutable_superStickerDetails()

LiveChatSuperStickerDetails google_youtube_api::LiveChatMessageSnippet::mutable_superStickerDetails ( )

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

Details about the Super Sticker event, this is only set if the type is 'superStickerEvent'.

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

◆ mutable_textMessageDetails()

LiveChatTextMessageDetails google_youtube_api::LiveChatMessageSnippet::mutable_textMessageDetails ( )

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

Details about the text message, this is only set if the type is 'textMessageEvent'.

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

◆ mutable_userBannedDetails()

LiveChatUserBannedMessageDetails google_youtube_api::LiveChatMessageSnippet::mutable_userBannedDetails ( )

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

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

◆ New()

LiveChatMessageSnippet * google_youtube_api::LiveChatMessageSnippet::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_author_channel_id()

void google_youtube_api::LiveChatMessageSnippet::set_author_channel_id ( const StringPiece &  value)
inline

Change the 'authorChannelId' attribute.

The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent

  • the user that funded the broadcast newSponsorEvent - the user that just became a sponsor messageDeletedEvent - the moderator that took the action messageRetractedEvent - the author that retracted their message userBannedEvent - the moderator that took the action superChatEvent - the user that made the purchase.
Parameters
[in]valueThe new value.

◆ set_display_message()

void google_youtube_api::LiveChatMessageSnippet::set_display_message ( const StringPiece &  value)
inline

Change the 'displayMessage' attribute.

Contains a string that can be displayed to the user. If this field is not present the message is silent, at the moment only messages of type TOMBSTONE and CHAT_ENDED_EVENT are silent.

Parameters
[in]valueThe new value.

◆ set_has_display_content()

void google_youtube_api::LiveChatMessageSnippet::set_has_display_content ( bool  value)
inline

Change the 'hasDisplayContent' attribute.

Whether the message has display content that should be displayed to users.

Parameters
[in]valueThe new value.

◆ set_live_chat_id()

void google_youtube_api::LiveChatMessageSnippet::set_live_chat_id ( const StringPiece &  value)
inline

Change the 'liveChatId' attribute.

Parameters
[in]valueThe new value.

◆ set_published_at()

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

Change the 'publishedAt' attribute.

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

Parameters
[in]valueThe new value.

◆ set_type()

void google_youtube_api::LiveChatMessageSnippet::set_type ( const StringPiece &  value)
inline

Change the 'type' attribute.

The type of message, this will always be present, it determines the contents of the message as well as which fields will be present.

Parameters
[in]valueThe new value.

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