Class: Google::Apis::YoutubeV3::SuperChatEventSnippet

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/youtube_v3/classes.rb,
generated/google/apis/youtube_v3/representations.rb,
generated/google/apis/youtube_v3/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ SuperChatEventSnippet

Returns a new instance of SuperChatEventSnippet.



7127
7128
7129
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 7127

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#amount_micros ⇒ Fixnum

The purchase amount, in micros of the purchase currency. e.g., 1 is represented as 1000000. Corresponds to the JSON property amountMicros

Returns:

  • (Fixnum) 


7064
7065
7066
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 7064

def amount_micros
  @amount_micros
end

#channel_id ⇒ String

Channel id where the event occurred. Corresponds to the JSON property channelId

Returns:

  • (String) 


7069
7070
7071
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 7069

def channel_id
  @channel_id
end

#comment_text ⇒ String

The text contents of the comment left by the user. Corresponds to the JSON property commentText

Returns:

  • (String) 


7074
7075
7076
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 7074

def comment_text
  @comment_text
end

#created_at ⇒ DateTime

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

Returns:

  • (DateTime) 


7080
7081
7082
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 7080

def created_at
  @created_at
end

#currency ⇒ String

The currency in which the purchase was made. ISO 4217. Corresponds to the JSON property currency

Returns:

  • (String) 


7085
7086
7087
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 7085

def currency
  @currency
end

#display_string ⇒ String

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

Returns:

  • (String) 


7091
7092
7093
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 7091

def display_string
  @display_string
end

#is_super_chat_for_good ⇒ Boolean Also known as: is_super_chat_for_good?

True if this event is a Super Chat for Good purchase. Corresponds to the JSON property isSuperChatForGood

Returns:

  • (Boolean) 


7096
7097
7098
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 7096

def is_super_chat_for_good
  @is_super_chat_for_good
end

#is_super_sticker_event ⇒ Boolean Also known as: is_super_sticker_event?

True if this event is a Super Sticker event. Corresponds to the JSON property isSuperStickerEvent

Returns:

  • (Boolean) 


7102
7103
7104
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 7102

def is_super_sticker_event
  @is_super_sticker_event
end

#message_type ⇒ Fixnum

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

Returns:

  • (Fixnum) 


7109
7110
7111
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 7109

def message_type
  @message_type
end

#nonprofit ⇒ Google::Apis::YoutubeV3::Nonprofit

Nonprofit information. Corresponds to the JSON property nonprofit

Returns:



7114
7115
7116
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 7114

def nonprofit
  @nonprofit
end

#super_sticker_metadata ⇒ Google::Apis::YoutubeV3::SuperStickerMetadata

If this event is a Super Sticker event, this field will contain metadata about the Super Sticker. Corresponds to the JSON property superStickerMetadata

Returns:



7120
7121
7122
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 7120

def super_sticker_metadata
  @super_sticker_metadata
end

#supporter_details ⇒ Google::Apis::YoutubeV3::ChannelProfileDetails

Details about the supporter. Corresponds to the JSON property supporterDetails

Returns:



7125
7126
7127
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 7125

def supporter_details
  @supporter_details
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 7132

def update!(**args)
  @amount_micros = args[:amount_micros] if args.key?(:amount_micros)
  @channel_id = args[:channel_id] if args.key?(:channel_id)
  @comment_text = args[:comment_text] if args.key?(:comment_text)
  @created_at = args[:created_at] if args.key?(:created_at)
  @currency = args[:currency] if args.key?(:currency)
  @display_string = args[:display_string] if args.key?(:display_string)
  @is_super_chat_for_good = args[:is_super_chat_for_good] if args.key?(:is_super_chat_for_good)
  @is_super_sticker_event = args[:is_super_sticker_event] if args.key?(:is_super_sticker_event)
  @message_type = args[:message_type] if args.key?(:message_type)
  @nonprofit = args[:nonprofit] if args.key?(:nonprofit)
  @super_sticker_metadata = args[:super_sticker_metadata] if args.key?(:super_sticker_metadata)
  @supporter_details = args[:supporter_details] if args.key?(:supporter_details)
end