Class: Google::Apis::YoutubeV3::LiveChatMessageSnippet

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

Constructor Details

#initialize(**args) ⇒ LiveChatMessageSnippet

Returns a new instance of LiveChatMessageSnippet.



4373
4374
4375
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4373

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

Instance Attribute Details

#author_channel_id ⇒ String

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 Corresponds to the JSON property authorChannelId

Returns:

  • (String) 


4302
4303
4304
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4302

def author_channel_id
  @author_channel_id
end

#display_message ⇒ String

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. Corresponds to the JSON property displayMessage

Returns:

  • (String) 


4309
4310
4311
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4309

def display_message
  @display_message
end

#fan_funding_event_details ⇒ Google::Apis::YoutubeV3::LiveChatFanFundingEventDetails

Details about the funding event, this is only set if the type is ' fanFundingEvent'. Corresponds to the JSON property fanFundingEventDetails

Returns:



4315
4316
4317
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4315

def fan_funding_event_details
  @fan_funding_event_details
end

#has_display_content ⇒ Boolean Also known as: has_display_content?

Whether the message has display content that should be displayed to users. Corresponds to the JSON property hasDisplayContent

Returns:

  • (Boolean) 


4320
4321
4322
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4320

def has_display_content
  @has_display_content
end

#live_chat_id ⇒ String

Corresponds to the JSON property liveChatId

Returns:

  • (String) 


4326
4327
4328
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4326

def live_chat_id
  @live_chat_id
end

#message_deleted_details ⇒ Google::Apis::YoutubeV3::LiveChatMessageDeletedDetails

Corresponds to the JSON property messageDeletedDetails

Returns:



4331
4332
4333
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4331

def message_deleted_details
  @message_deleted_details
end

#message_retracted_details ⇒ Google::Apis::YoutubeV3::LiveChatMessageRetractedDetails

Corresponds to the JSON property messageRetractedDetails

Returns:



4336
4337
4338
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4336

def message_retracted_details
  @message_retracted_details
end

#published_at ⇒ String

The date and time when the message was orignally published. The value is specified in ISO 8601 format. Corresponds to the JSON property publishedAt

Returns:

  • (String) 


4342
4343
4344
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4342

def published_at
  @published_at
end

#super_chat_details ⇒ Google::Apis::YoutubeV3::LiveChatSuperChatDetails

Details about the Super Chat event, this is only set if the type is ' superChatEvent'. Corresponds to the JSON property superChatDetails

Returns:



4348
4349
4350
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4348

def super_chat_details
  @super_chat_details
end

#super_sticker_details ⇒ Google::Apis::YoutubeV3::LiveChatSuperStickerDetails

Details about the Super Sticker event, this is only set if the type is ' superStickerEvent'. Corresponds to the JSON property superStickerDetails

Returns:



4354
4355
4356
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4354

def super_sticker_details
  @super_sticker_details
end

#text_message_details ⇒ Google::Apis::YoutubeV3::LiveChatTextMessageDetails

Details about the text message, this is only set if the type is ' textMessageEvent'. Corresponds to the JSON property textMessageDetails

Returns:



4360
4361
4362
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4360

def text_message_details
  @text_message_details
end

#type ⇒ String

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

Returns:

  • (String) 


4366
4367
4368
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4366

def type
  @type
end

#user_banned_details ⇒ Google::Apis::YoutubeV3::LiveChatUserBannedMessageDetails

Corresponds to the JSON property userBannedDetails

Returns:



4371
4372
4373
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4371

def user_banned_details
  @user_banned_details
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4378

def update!(**args)
  @author_channel_id = args[:author_channel_id] if args.key?(:author_channel_id)
  @display_message = args[:display_message] if args.key?(:display_message)
  @fan_funding_event_details = args[:fan_funding_event_details] if args.key?(:fan_funding_event_details)
  @has_display_content = args[:has_display_content] if args.key?(:has_display_content)
  @live_chat_id = args[:live_chat_id] if args.key?(:live_chat_id)
  @message_deleted_details = args[:message_deleted_details] if args.key?(:message_deleted_details)
  @message_retracted_details = args[:message_retracted_details] if args.key?(:message_retracted_details)
  @published_at = args[:published_at] if args.key?(:published_at)
  @super_chat_details = args[:super_chat_details] if args.key?(:super_chat_details)
  @super_sticker_details = args[:super_sticker_details] if args.key?(:super_sticker_details)
  @text_message_details = args[:text_message_details] if args.key?(:text_message_details)
  @type = args[:type] if args.key?(:type)
  @user_banned_details = args[:user_banned_details] if args.key?(:user_banned_details)
end