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.



4585
4586
4587
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4585

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

Returns:

  • (String) 


4506
4507
4508
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4506

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) 


4513
4514
4515
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4513

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:



4519
4520
4521
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4519

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) 


4524
4525
4526
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4524

def has_display_content
  @has_display_content
end

#live_chat_id ⇒ String

Corresponds to the JSON property liveChatId

Returns:

  • (String) 


4530
4531
4532
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4530

def live_chat_id
  @live_chat_id
end

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

Corresponds to the JSON property messageDeletedDetails

Returns:



4535
4536
4537
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4535

def message_deleted_details
  @message_deleted_details
end

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

Corresponds to the JSON property messageRetractedDetails

Returns:



4540
4541
4542
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4540

def message_retracted_details
  @message_retracted_details
end

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

Corresponds to the JSON property pollClosedDetails

Returns:



4545
4546
4547
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4545

def poll_closed_details
  @poll_closed_details
end

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

Corresponds to the JSON property pollEditedDetails

Returns:



4550
4551
4552
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4550

def poll_edited_details
  @poll_edited_details
end

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

Corresponds to the JSON property pollOpenedDetails

Returns:



4555
4556
4557
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4555

def poll_opened_details
  @poll_opened_details
end

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

Corresponds to the JSON property pollVotedDetails

Returns:



4560
4561
4562
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4560

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) 


4566
4567
4568
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4566

def published_at
  @published_at
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:



4572
4573
4574
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4572

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) 


4578
4579
4580
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4578

def type
  @type
end

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

Corresponds to the JSON property userBannedDetails

Returns:



4583
4584
4585
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4583

def user_banned_details
  @user_banned_details
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 4590

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