Class: Google::Apis::YoutubeV3::LiveChatMessageSnippet
- Inherits:
-
Object
- Object
- Google::Apis::YoutubeV3::LiveChatMessageSnippet
- 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
-
#author_channel_id ⇒ String
The ID of the user that authored this message, this field is not always filled.
-
#display_message ⇒ String
Contains a string that can be displayed to the user.
-
#fan_funding_event_details ⇒ Google::Apis::YoutubeV3::LiveChatFanFundingEventDetails
Details about the funding event, this is only set if the type is ' fanFundingEvent'.
-
#has_display_content ⇒ Boolean
(also: #has_display_content?)
Whether the message has display content that should be displayed to users.
-
#live_chat_id ⇒ String
Corresponds to the JSON property
liveChatId
. -
#message_deleted_details ⇒ Google::Apis::YoutubeV3::LiveChatMessageDeletedDetails
Corresponds to the JSON property
messageDeletedDetails
. -
#message_retracted_details ⇒ Google::Apis::YoutubeV3::LiveChatMessageRetractedDetails
Corresponds to the JSON property
messageRetractedDetails
. -
#poll_closed_details ⇒ Google::Apis::YoutubeV3::LiveChatPollClosedDetails
Corresponds to the JSON property
pollClosedDetails
. -
#poll_edited_details ⇒ Google::Apis::YoutubeV3::LiveChatPollEditedDetails
Corresponds to the JSON property
pollEditedDetails
. -
#poll_opened_details ⇒ Google::Apis::YoutubeV3::LiveChatPollOpenedDetails
Corresponds to the JSON property
pollOpenedDetails
. -
#poll_voted_details ⇒ Google::Apis::YoutubeV3::LiveChatPollVotedDetails
Corresponds to the JSON property
pollVotedDetails
. -
#published_at ⇒ DateTime
The date and time when the message was orignally published.
-
#super_chat_details ⇒ Google::Apis::YoutubeV3::LiveChatSuperChatDetails
Details about the Super Chat event, this is only set if the type is ' superChatEvent'.
-
#super_sticker_details ⇒ Google::Apis::YoutubeV3::LiveChatSuperStickerDetails
Details about the Super Sticker event, this is only set if the type is ' superStickerEvent'.
-
#text_message_details ⇒ Google::Apis::YoutubeV3::LiveChatTextMessageDetails
Details about the text message, this is only set if the type is ' textMessageEvent'.
-
#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.
-
#user_banned_details ⇒ Google::Apis::YoutubeV3::LiveChatUserBannedMessageDetails
Corresponds to the JSON property
userBannedDetails
.
Instance Method Summary collapse
-
#initialize(**args) ⇒ LiveChatMessageSnippet
constructor
A new instance of LiveChatMessageSnippet.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ LiveChatMessageSnippet
Returns a new instance of LiveChatMessageSnippet.
4441 4442 4443 |
# File 'generated/google/apis/youtube_v3/classes.rb', line 4441 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
4350 4351 4352 |
# File 'generated/google/apis/youtube_v3/classes.rb', line 4350 def @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
4357 4358 4359 |
# File 'generated/google/apis/youtube_v3/classes.rb', line 4357 def @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
4363 4364 4365 |
# File 'generated/google/apis/youtube_v3/classes.rb', line 4363 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
4368 4369 4370 |
# File 'generated/google/apis/youtube_v3/classes.rb', line 4368 def has_display_content @has_display_content end |
#live_chat_id ⇒ String
Corresponds to the JSON property liveChatId
4374 4375 4376 |
# File 'generated/google/apis/youtube_v3/classes.rb', line 4374 def live_chat_id @live_chat_id end |
#message_deleted_details ⇒ Google::Apis::YoutubeV3::LiveChatMessageDeletedDetails
Corresponds to the JSON property messageDeletedDetails
4379 4380 4381 |
# File 'generated/google/apis/youtube_v3/classes.rb', line 4379 def @message_deleted_details end |
#message_retracted_details ⇒ Google::Apis::YoutubeV3::LiveChatMessageRetractedDetails
Corresponds to the JSON property messageRetractedDetails
4384 4385 4386 |
# File 'generated/google/apis/youtube_v3/classes.rb', line 4384 def @message_retracted_details end |
#poll_closed_details ⇒ Google::Apis::YoutubeV3::LiveChatPollClosedDetails
Corresponds to the JSON property pollClosedDetails
4389 4390 4391 |
# File 'generated/google/apis/youtube_v3/classes.rb', line 4389 def poll_closed_details @poll_closed_details end |
#poll_edited_details ⇒ Google::Apis::YoutubeV3::LiveChatPollEditedDetails
Corresponds to the JSON property pollEditedDetails
4394 4395 4396 |
# File 'generated/google/apis/youtube_v3/classes.rb', line 4394 def poll_edited_details @poll_edited_details end |
#poll_opened_details ⇒ Google::Apis::YoutubeV3::LiveChatPollOpenedDetails
Corresponds to the JSON property pollOpenedDetails
4399 4400 4401 |
# File 'generated/google/apis/youtube_v3/classes.rb', line 4399 def poll_opened_details @poll_opened_details end |
#poll_voted_details ⇒ Google::Apis::YoutubeV3::LiveChatPollVotedDetails
Corresponds to the JSON property pollVotedDetails
4404 4405 4406 |
# File 'generated/google/apis/youtube_v3/classes.rb', line 4404 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
4410 4411 4412 |
# File 'generated/google/apis/youtube_v3/classes.rb', line 4410 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
4416 4417 4418 |
# File 'generated/google/apis/youtube_v3/classes.rb', line 4416 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
4422 4423 4424 |
# File 'generated/google/apis/youtube_v3/classes.rb', line 4422 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
4428 4429 4430 |
# File 'generated/google/apis/youtube_v3/classes.rb', line 4428 def @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
4434 4435 4436 |
# File 'generated/google/apis/youtube_v3/classes.rb', line 4434 def type @type end |
#user_banned_details ⇒ Google::Apis::YoutubeV3::LiveChatUserBannedMessageDetails
Corresponds to the JSON property userBannedDetails
4439 4440 4441 |
# File 'generated/google/apis/youtube_v3/classes.rb', line 4439 def user_banned_details @user_banned_details end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 |
# File 'generated/google/apis/youtube_v3/classes.rb', line 4446 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 |