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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/youtube_v3/classes.rb,
lib/google/apis/youtube_v3/representations.rb,
lib/google/apis/youtube_v3/representations.rb

Overview

Next ID: 35

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ LiveChatMessageSnippet

Returns a new instance of LiveChatMessageSnippet.



4866
4867
4868
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 4866

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 memberMilestoneChatEvent - the member that sent the message membershipGiftingEvent - the user that made the purchase giftMembershipReceivedEvent - the user that received the gift membership messageDeletedEvent - the moderator that took the action. Unused. messageRetractedEvent - the author that retracted their message. Unused. userBannedEvent - the moderator that took the action superChatEvent - the user that made the purchase superStickerEvent - the user that made the purchase pollEvent - the user that created the poll Corresponds to the JSON property authorChannelId

Returns:

  • (String) 


4762
4763
4764
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 4762

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) 


4769
4770
4771
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 4769

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:



4775
4776
4777
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 4775

def fan_funding_event_details
  @fan_funding_event_details
end

#gift_details ⇒ Google::Apis::YoutubeV3::LiveChatGiftDetails

Details about the gift event, this is only set if the type is 'giftEvent'. Corresponds to the JSON property giftDetails

Returns:



4780
4781
4782
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 4780

def gift_details
  @gift_details
end

#gift_membership_received_details ⇒ Google::Apis::YoutubeV3::LiveChatGiftMembershipReceivedDetails

Details about the Gift Membership Received event, this is only set if the type is 'giftMembershipReceivedEvent'. Corresponds to the JSON property giftMembershipReceivedDetails

Returns:



4786
4787
4788
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 4786

def gift_membership_received_details
  @gift_membership_received_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) 


4791
4792
4793
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 4791

def has_display_content
  @has_display_content
end

#live_chat_id ⇒ String

Corresponds to the JSON property liveChatId

Returns:

  • (String) 


4797
4798
4799
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 4797

def live_chat_id
  @live_chat_id
end

#member_milestone_chat_details ⇒ Google::Apis::YoutubeV3::LiveChatMemberMilestoneChatDetails

Details about the Member Milestone Chat event, this is only set if the type is 'memberMilestoneChatEvent'. Corresponds to the JSON property memberMilestoneChatDetails

Returns:



4803
4804
4805
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 4803

def member_milestone_chat_details
  @member_milestone_chat_details
end

#membership_gifting_details ⇒ Google::Apis::YoutubeV3::LiveChatMembershipGiftingDetails

Details about the Membership Gifting event, this is only set if the type is ' membershipGiftingEvent'. Corresponds to the JSON property membershipGiftingDetails

Returns:



4809
4810
4811
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 4809

def membership_gifting_details
  @membership_gifting_details
end

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

Corresponds to the JSON property messageDeletedDetails

Returns:



4814
4815
4816
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 4814

def message_deleted_details
  @message_deleted_details
end

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

Corresponds to the JSON property messageRetractedDetails

Returns:



4819
4820
4821
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 4819

def message_retracted_details
  @message_retracted_details
end

#new_sponsor_details ⇒ Google::Apis::YoutubeV3::LiveChatNewSponsorDetails

Details about the New Member Announcement event, this is only set if the type is 'newSponsorEvent'. Please note that "member" is the new term for "sponsor". Corresponds to the JSON property newSponsorDetails

Returns:



4825
4826
4827
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 4825

def new_sponsor_details
  @new_sponsor_details
end

#poll_details ⇒ Google::Apis::YoutubeV3::LiveChatPollDetails

Details about the poll event, this is only set if the type is 'pollEvent'. Corresponds to the JSON property pollDetails

Returns:



4830
4831
4832
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 4830

def poll_details
  @poll_details
end

#published_at ⇒ DateTime

The date and time when the message was orignally published. Corresponds to the JSON property publishedAt

Returns:

  • (DateTime) 


4835
4836
4837
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 4835

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:



4841
4842
4843
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 4841

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:



4847
4848
4849
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 4847

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:



4853
4854
4855
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 4853

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) 


4859
4860
4861
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 4859

def type
  @type
end

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

Corresponds to the JSON property userBannedDetails

Returns:



4864
4865
4866
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 4864

def user_banned_details
  @user_banned_details
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 4871

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)
  @gift_details = args[:gift_details] if args.key?(:gift_details)
  @gift_membership_received_details = args[:gift_membership_received_details] if args.key?(:gift_membership_received_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)
  @member_milestone_chat_details = args[:member_milestone_chat_details] if args.key?(:member_milestone_chat_details)
  @membership_gifting_details = args[:membership_gifting_details] if args.key?(:membership_gifting_details)
  @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)
  @new_sponsor_details = args[:new_sponsor_details] if args.key?(:new_sponsor_details)
  @poll_details = args[:poll_details] if args.key?(:poll_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