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

#include <super_chat_event_snippet.h>

Inheritance diagram for google_youtube_api::SuperChatEventSnippet:

Public Member Functions

 SuperChatEventSnippet (const Json::Value &storage)
 
 SuperChatEventSnippet (Json::Value *storage)
 
virtual ~SuperChatEventSnippet ()
 
const StringPiece GetTypeName () const
 
bool has_amount_micros () const
 
void clear_amount_micros ()
 
uint64 get_amount_micros () const
 
void set_amount_micros (uint64 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_comment_text () const
 
void clear_comment_text ()
 
const StringPiece get_comment_text () const
 
void set_comment_text (const StringPiece &value)
 
bool has_created_at () const
 
void clear_created_at ()
 
client::DateTime get_created_at () const
 
void set_created_at (client::DateTime value)
 
bool has_currency () const
 
void clear_currency ()
 
const StringPiece get_currency () const
 
void set_currency (const StringPiece &value)
 
bool has_display_string () const
 
void clear_display_string ()
 
const StringPiece get_display_string () const
 
void set_display_string (const StringPiece &value)
 
bool has_is_super_chat_for_good () const
 
void clear_is_super_chat_for_good ()
 
bool get_is_super_chat_for_good () const
 
void set_is_super_chat_for_good (bool value)
 
bool has_is_super_sticker_event () const
 
void clear_is_super_sticker_event ()
 
bool get_is_super_sticker_event () const
 
void set_is_super_sticker_event (bool value)
 
bool has_message_type () const
 
void clear_message_type ()
 
uint32 get_message_type () const
 
void set_message_type (uint32 value)
 
bool has_nonprofit () const
 
void clear_nonprofit ()
 
const Nonprofit get_nonprofit () const
 
Nonprofit mutable_nonprofit ()
 
bool has_super_sticker_metadata () const
 
void clear_super_sticker_metadata ()
 
const SuperStickerMetadata get_super_sticker_metadata () const
 
SuperStickerMetadata mutable_superStickerMetadata ()
 
bool has_supporter_details () const
 
void clear_supporter_details ()
 
const ChannelProfileDetails get_supporter_details () const
 
ChannelProfileDetails mutable_supporterDetails ()
 

Static Public Member Functions

static SuperChatEventSnippetNew ()
 

Detailed Description

No description provided.

Constructor & Destructor Documentation

◆ SuperChatEventSnippet() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ SuperChatEventSnippet() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~SuperChatEventSnippet()

google_youtube_api::SuperChatEventSnippet::~SuperChatEventSnippet ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_amount_micros()

void google_youtube_api::SuperChatEventSnippet::clear_amount_micros ( )
inline

Clears the 'amountMicros' attribute.

◆ clear_channel_id()

void google_youtube_api::SuperChatEventSnippet::clear_channel_id ( )
inline

Clears the 'channelId' attribute.

◆ clear_comment_text()

void google_youtube_api::SuperChatEventSnippet::clear_comment_text ( )
inline

Clears the 'commentText' attribute.

◆ clear_created_at()

void google_youtube_api::SuperChatEventSnippet::clear_created_at ( )
inline

Clears the 'createdAt' attribute.

◆ clear_currency()

void google_youtube_api::SuperChatEventSnippet::clear_currency ( )
inline

Clears the 'currency' attribute.

◆ clear_display_string()

void google_youtube_api::SuperChatEventSnippet::clear_display_string ( )
inline

Clears the 'displayString' attribute.

◆ clear_is_super_chat_for_good()

void google_youtube_api::SuperChatEventSnippet::clear_is_super_chat_for_good ( )
inline

Clears the 'isSuperChatForGood' attribute.

◆ clear_is_super_sticker_event()

void google_youtube_api::SuperChatEventSnippet::clear_is_super_sticker_event ( )
inline

Clears the 'isSuperStickerEvent' attribute.

◆ clear_message_type()

void google_youtube_api::SuperChatEventSnippet::clear_message_type ( )
inline

Clears the 'messageType' attribute.

◆ clear_nonprofit()

void google_youtube_api::SuperChatEventSnippet::clear_nonprofit ( )
inline

Clears the 'nonprofit' attribute.

◆ clear_super_sticker_metadata()

void google_youtube_api::SuperChatEventSnippet::clear_super_sticker_metadata ( )
inline

Clears the 'superStickerMetadata' attribute.

◆ clear_supporter_details()

void google_youtube_api::SuperChatEventSnippet::clear_supporter_details ( )
inline

Clears the 'supporterDetails' attribute.

◆ get_amount_micros()

uint64 google_youtube_api::SuperChatEventSnippet::get_amount_micros ( ) const
inline

Get the value of the 'amountMicros' attribute.

◆ get_channel_id()

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

Get the value of the 'channelId' attribute.

◆ get_comment_text()

const StringPiece google_youtube_api::SuperChatEventSnippet::get_comment_text ( ) const
inline

Get the value of the 'commentText' attribute.

◆ get_created_at()

client::DateTime google_youtube_api::SuperChatEventSnippet::get_created_at ( ) const
inline

Get the value of the 'createdAt' attribute.

◆ get_currency()

const StringPiece google_youtube_api::SuperChatEventSnippet::get_currency ( ) const
inline

Get the value of the 'currency' attribute.

◆ get_display_string()

const StringPiece google_youtube_api::SuperChatEventSnippet::get_display_string ( ) const
inline

Get the value of the 'displayString' attribute.

◆ get_is_super_chat_for_good()

bool google_youtube_api::SuperChatEventSnippet::get_is_super_chat_for_good ( ) const
inline

Get the value of the 'isSuperChatForGood' attribute.

◆ get_is_super_sticker_event()

bool google_youtube_api::SuperChatEventSnippet::get_is_super_sticker_event ( ) const
inline

Get the value of the 'isSuperStickerEvent' attribute.

◆ get_message_type()

uint32 google_youtube_api::SuperChatEventSnippet::get_message_type ( ) const
inline

Get the value of the 'messageType' attribute.

◆ get_nonprofit()

const Nonprofit google_youtube_api::SuperChatEventSnippet::get_nonprofit ( ) const

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

◆ get_super_sticker_metadata()

const SuperStickerMetadata google_youtube_api::SuperChatEventSnippet::get_super_sticker_metadata ( ) const

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

◆ get_supporter_details()

const ChannelProfileDetails google_youtube_api::SuperChatEventSnippet::get_supporter_details ( ) const

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

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_youtube_api::SuperChatEventSnippet

◆ has_amount_micros()

bool google_youtube_api::SuperChatEventSnippet::has_amount_micros ( ) const
inline

Determine if the 'amountMicros' attribute was set.

Returns
true if the 'amountMicros' attribute was set.

◆ has_channel_id()

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

Determine if the 'channelId' attribute was set.

Returns
true if the 'channelId' attribute was set.

◆ has_comment_text()

bool google_youtube_api::SuperChatEventSnippet::has_comment_text ( ) const
inline

Determine if the 'commentText' attribute was set.

Returns
true if the 'commentText' attribute was set.

◆ has_created_at()

bool google_youtube_api::SuperChatEventSnippet::has_created_at ( ) const
inline

Determine if the 'createdAt' attribute was set.

Returns
true if the 'createdAt' attribute was set.

◆ has_currency()

bool google_youtube_api::SuperChatEventSnippet::has_currency ( ) const
inline

Determine if the 'currency' attribute was set.

Returns
true if the 'currency' attribute was set.

◆ has_display_string()

bool google_youtube_api::SuperChatEventSnippet::has_display_string ( ) const
inline

Determine if the 'displayString' attribute was set.

Returns
true if the 'displayString' attribute was set.

◆ has_is_super_chat_for_good()

bool google_youtube_api::SuperChatEventSnippet::has_is_super_chat_for_good ( ) const
inline

Determine if the 'isSuperChatForGood' attribute was set.

Returns
true if the 'isSuperChatForGood' attribute was set.

◆ has_is_super_sticker_event()

bool google_youtube_api::SuperChatEventSnippet::has_is_super_sticker_event ( ) const
inline

Determine if the 'isSuperStickerEvent' attribute was set.

Returns
true if the 'isSuperStickerEvent' attribute was set.

◆ has_message_type()

bool google_youtube_api::SuperChatEventSnippet::has_message_type ( ) const
inline

Determine if the 'messageType' attribute was set.

Returns
true if the 'messageType' attribute was set.

◆ has_nonprofit()

bool google_youtube_api::SuperChatEventSnippet::has_nonprofit ( ) const
inline

Determine if the 'nonprofit' attribute was set.

Returns
true if the 'nonprofit' attribute was set.

◆ has_super_sticker_metadata()

bool google_youtube_api::SuperChatEventSnippet::has_super_sticker_metadata ( ) const
inline

Determine if the 'superStickerMetadata' attribute was set.

Returns
true if the 'superStickerMetadata' attribute was set.

◆ has_supporter_details()

bool google_youtube_api::SuperChatEventSnippet::has_supporter_details ( ) const
inline

Determine if the 'supporterDetails' attribute was set.

Returns
true if the 'supporterDetails' attribute was set.

◆ mutable_nonprofit()

Nonprofit google_youtube_api::SuperChatEventSnippet::mutable_nonprofit ( )

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

If this event is a Super Chat for Good purchase, this field will contain information about the charity the purchase is donated to.

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

◆ mutable_superStickerMetadata()

SuperStickerMetadata google_youtube_api::SuperChatEventSnippet::mutable_superStickerMetadata ( )

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

If this event is a Super Sticker event, this field will contain metadata about the Super Sticker.

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

◆ mutable_supporterDetails()

ChannelProfileDetails google_youtube_api::SuperChatEventSnippet::mutable_supporterDetails ( )

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

Details about the supporter.

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

◆ New()

SuperChatEventSnippet * google_youtube_api::SuperChatEventSnippet::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_amount_micros()

void google_youtube_api::SuperChatEventSnippet::set_amount_micros ( uint64  value)
inline

Change the 'amountMicros' attribute.

The purchase amount, in micros of the purchase currency. e.g., 1 is represented as 1000000.

Parameters
[in]valueThe new value.

◆ set_channel_id()

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

Change the 'channelId' attribute.

Channel id where the event occurred.

Parameters
[in]valueThe new value.

◆ set_comment_text()

void google_youtube_api::SuperChatEventSnippet::set_comment_text ( const StringPiece &  value)
inline

Change the 'commentText' attribute.

The text contents of the comment left by the user.

Parameters
[in]valueThe new value.

◆ set_created_at()

void google_youtube_api::SuperChatEventSnippet::set_created_at ( client::DateTime  value)
inline

Change the 'createdAt' attribute.

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

Parameters
[in]valueThe new value.

◆ set_currency()

void google_youtube_api::SuperChatEventSnippet::set_currency ( const StringPiece &  value)
inline

Change the 'currency' attribute.

The currency in which the purchase was made. ISO 4217.

Parameters
[in]valueThe new value.

◆ set_display_string()

void google_youtube_api::SuperChatEventSnippet::set_display_string ( const StringPiece &  value)
inline

Change the 'displayString' attribute.

A rendered string that displays the purchase amount and currency (e.g., "$1.00"). The string is rendered for the given language.

Parameters
[in]valueThe new value.

◆ set_is_super_chat_for_good()

void google_youtube_api::SuperChatEventSnippet::set_is_super_chat_for_good ( bool  value)
inline

Change the 'isSuperChatForGood' attribute.

True if this event is a Super Chat for Good purchase.

Parameters
[in]valueThe new value.

◆ set_is_super_sticker_event()

void google_youtube_api::SuperChatEventSnippet::set_is_super_sticker_event ( bool  value)
inline

Change the 'isSuperStickerEvent' attribute.

True if this event is a Super Sticker event.

Parameters
[in]valueThe new value.

◆ set_message_type()

void google_youtube_api::SuperChatEventSnippet::set_message_type ( uint32  value)
inline

Change the 'messageType' attribute.

The tier for the paid message, which is based on the amount of money spent to purchase the message.

Parameters
[in]valueThe new value.

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