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



6711
6712
6713
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 6711

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) 


6660
6661
6662
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 6660

def amount_micros
  @amount_micros
end

#channel_id ⇒ String

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

Returns:

  • (String) 


6665
6666
6667
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 6665

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) 


6670
6671
6672
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 6670

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) 


6676
6677
6678
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 6676

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) 


6681
6682
6683
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 6681

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) 


6687
6688
6689
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 6687

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) 


6692
6693
6694
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 6692

def is_super_chat_for_good
  @is_super_chat_for_good
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) 


6699
6700
6701
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 6699

def message_type
  @message_type
end

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

Nonprofit information. Corresponds to the JSON property nonprofit

Returns:



6704
6705
6706
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 6704

def nonprofit
  @nonprofit
end

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

Details about the supporter. Corresponds to the JSON property supporterDetails

Returns:



6709
6710
6711
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 6709

def supporter_details
  @supporter_details
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 6716

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)
  @message_type = args[:message_type] if args.key?(:message_type)
  @nonprofit = args[:nonprofit] if args.key?(:nonprofit)
  @supporter_details = args[:supporter_details] if args.key?(:supporter_details)
end