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



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

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) 


7028
7029
7030
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 7028

def amount_micros
  @amount_micros
end

#channel_id ⇒ String

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

Returns:

  • (String) 


7033
7034
7035
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 7033

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) 


7038
7039
7040
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 7038

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) 


7044
7045
7046
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 7044

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) 


7049
7050
7051
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 7049

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) 


7055
7056
7057
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 7055

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) 


7060
7061
7062
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 7060

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) 


7066
7067
7068
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 7066

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) 


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

def message_type
  @message_type
end

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

Nonprofit information. Corresponds to the JSON property nonprofit

Returns:



7078
7079
7080
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 7078

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:



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

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:



7089
7090
7091
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 7089

def supporter_details
  @supporter_details
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 7096

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