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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ LiveChatMessageSnippet

Returns a new instance of LiveChatMessageSnippet.



4445
4446
4447
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4445

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) 


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

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) 


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

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:



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

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) 


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

def has_display_content
  @has_display_content
end

#live_chat_id ⇒ String

Corresponds to the JSON property liveChatId

Returns:

  • (String) 


4378
4379
4380
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4378

def live_chat_id
  @live_chat_id
end

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

Corresponds to the JSON property messageDeletedDetails

Returns:



4383
4384
4385
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4383

def message_deleted_details
  @message_deleted_details
end

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

Corresponds to the JSON property messageRetractedDetails

Returns:



4388
4389
4390
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4388

def message_retracted_details
  @message_retracted_details
end

#poll_closed_details ⇒ Google::Apis::YoutubeV3::LiveChatPollClosedDetails

Corresponds to the JSON property pollClosedDetails

Returns:



4393
4394
4395
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4393

def poll_closed_details
  @poll_closed_details
end

#poll_edited_details ⇒ Google::Apis::YoutubeV3::LiveChatPollEditedDetails

Corresponds to the JSON property pollEditedDetails

Returns:



4398
4399
4400
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4398

def poll_edited_details
  @poll_edited_details
end

#poll_opened_details ⇒ Google::Apis::YoutubeV3::LiveChatPollOpenedDetails

Corresponds to the JSON property pollOpenedDetails

Returns:



4403
4404
4405
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4403

def poll_opened_details
  @poll_opened_details
end

#poll_voted_details ⇒ Google::Apis::YoutubeV3::LiveChatPollVotedDetails

Corresponds to the JSON property pollVotedDetails

Returns:



4408
4409
4410
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4408

def poll_voted_details
  @poll_voted_details
end

#published_at ⇒ DateTime

The date and time when the message was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. Corresponds to the JSON property publishedAt

Returns:

  • (DateTime) 


4414
4415
4416
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4414

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:



4420
4421
4422
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4420

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:



4426
4427
4428
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4426

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:



4432
4433
4434
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4432

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) 


4438
4439
4440
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4438

def type
  @type
end

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

Corresponds to the JSON property userBannedDetails

Returns:



4443
4444
4445
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4443

def user_banned_details
  @user_banned_details
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4450

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)
  @poll_closed_details = args[:poll_closed_details] if args.key?(:poll_closed_details)
  @poll_edited_details = args[:poll_edited_details] if args.key?(:poll_edited_details)
  @poll_opened_details = args[:poll_opened_details] if args.key?(:poll_opened_details)
  @poll_voted_details = args[:poll_voted_details] if args.key?(:poll_voted_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