com.google.api.services.youtube.model

Class LiveChatMessageSnippet

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.youtube.model.LiveChatMessageSnippet

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class LiveChatMessageSnippet
extends GenericJson

Model definition for LiveChatMessageSnippet.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the YouTube Data API v3. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
LiveChatMessageSnippet()

Method Summary

Modifier and Type	Method and Description
LiveChatMessageSnippet	clone()
String	getAuthorChannelId() The ID of the user that authored this message, this field is not always filled.
String	getDisplayMessage() Contains a string that can be displayed to the user.
LiveChatFanFundingEventDetails	getFanFundingEventDetails() Details about the funding event, this is only set if the type is 'fanFundingEvent'.
Boolean	getHasDisplayContent() Whether the message has display content that should be displayed to users.
String	getLiveChatId()
LiveChatMessageDeletedDetails	getMessageDeletedDetails()
LiveChatMessageRetractedDetails	getMessageRetractedDetails()
DateTime	getPublishedAt() The date and time when the message was orignally published.
LiveChatSuperChatDetails	getSuperChatDetails() Details about the Super Chat event, this is only set if the type is 'superChatEvent'.
LiveChatSuperStickerDetails	getSuperStickerDetails() Details about the Super Sticker event, this is only set if the type is 'superStickerEvent'.
LiveChatTextMessageDetails	getTextMessageDetails() Details about the text message, this is only set if the type is 'textMessageEvent'.
String	getType() The type of message, this will always be present, it determines the contents of the message as well as which fields will be present.
LiveChatUserBannedMessageDetails	getUserBannedDetails()
LiveChatMessageSnippet	set(String fieldName, Object value)
LiveChatMessageSnippet	setAuthorChannelId(String authorChannelId) The ID of the user that authored this message, this field is not always filled.
LiveChatMessageSnippet	setDisplayMessage(String displayMessage) Contains a string that can be displayed to the user.
LiveChatMessageSnippet	setFanFundingEventDetails(LiveChatFanFundingEventDetails fanFundingEventDetails) Details about the funding event, this is only set if the type is 'fanFundingEvent'.
LiveChatMessageSnippet	setHasDisplayContent(Boolean hasDisplayContent) Whether the message has display content that should be displayed to users.
LiveChatMessageSnippet	setLiveChatId(String liveChatId)
LiveChatMessageSnippet	setMessageDeletedDetails(LiveChatMessageDeletedDetails messageDeletedDetails)
LiveChatMessageSnippet	setMessageRetractedDetails(LiveChatMessageRetractedDetails messageRetractedDetails)
LiveChatMessageSnippet	setPublishedAt(DateTime publishedAt) The date and time when the message was orignally published.
LiveChatMessageSnippet	setSuperChatDetails(LiveChatSuperChatDetails superChatDetails) Details about the Super Chat event, this is only set if the type is 'superChatEvent'.
LiveChatMessageSnippet	setSuperStickerDetails(LiveChatSuperStickerDetails superStickerDetails) Details about the Super Sticker event, this is only set if the type is 'superStickerEvent'.
LiveChatMessageSnippet	setTextMessageDetails(LiveChatTextMessageDetails textMessageDetails) Details about the text message, this is only set if the type is 'textMessageEvent'.
LiveChatMessageSnippet	setType(String type) The type of message, this will always be present, it determines the contents of the message as well as which fields will be present.
LiveChatMessageSnippet	setUserBannedDetails(LiveChatUserBannedMessageDetails userBannedDetails)

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

LiveChatMessageSnippet

public LiveChatMessageSnippet()

Method Detail

getAuthorChannelId

public String getAuthorChannelId()

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

Returns:

value or null for none

setAuthorChannelId

public LiveChatMessageSnippet setAuthorChannelId(String authorChannelId)

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

Parameters:

authorChannelId - authorChannelId or null for none

getDisplayMessage

public String getDisplayMessage()

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.

Returns:

value or null for none

setDisplayMessage

public LiveChatMessageSnippet setDisplayMessage(String displayMessage)

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.

Parameters:

displayMessage - displayMessage or null for none

getFanFundingEventDetails

public LiveChatFanFundingEventDetails getFanFundingEventDetails()

Details about the funding event, this is only set if the type is 'fanFundingEvent'.

Returns:

value or null for none

setFanFundingEventDetails

public LiveChatMessageSnippet setFanFundingEventDetails(LiveChatFanFundingEventDetails fanFundingEventDetails)

Details about the funding event, this is only set if the type is 'fanFundingEvent'.

Parameters:

fanFundingEventDetails - fanFundingEventDetails or null for none

getHasDisplayContent

public Boolean getHasDisplayContent()

Whether the message has display content that should be displayed to users.

Returns:

value or null for none

setHasDisplayContent

public LiveChatMessageSnippet setHasDisplayContent(Boolean hasDisplayContent)

Whether the message has display content that should be displayed to users.

Parameters:

hasDisplayContent - hasDisplayContent or null for none

getLiveChatId

public String getLiveChatId()

Returns:

value or null for none

setLiveChatId

public LiveChatMessageSnippet setLiveChatId(String liveChatId)

Parameters:

liveChatId - liveChatId or null for none

getMessageDeletedDetails

public LiveChatMessageDeletedDetails getMessageDeletedDetails()

Returns:

value or null for none

setMessageDeletedDetails

public LiveChatMessageSnippet setMessageDeletedDetails(LiveChatMessageDeletedDetails messageDeletedDetails)

Parameters:

messageDeletedDetails - messageDeletedDetails or null for none

getMessageRetractedDetails

public LiveChatMessageRetractedDetails getMessageRetractedDetails()

Returns:

value or null for none

setMessageRetractedDetails

public LiveChatMessageSnippet setMessageRetractedDetails(LiveChatMessageRetractedDetails messageRetractedDetails)

Parameters:

messageRetractedDetails - messageRetractedDetails or null for none

getPublishedAt

public DateTime getPublishedAt()

The date and time when the message was orignally published.

Returns:

value or null for none

setPublishedAt

public LiveChatMessageSnippet setPublishedAt(DateTime publishedAt)

The date and time when the message was orignally published.

Parameters:

publishedAt - publishedAt or null for none

getSuperChatDetails

public LiveChatSuperChatDetails getSuperChatDetails()

Details about the Super Chat event, this is only set if the type is 'superChatEvent'.

Returns:

value or null for none

setSuperChatDetails

public LiveChatMessageSnippet setSuperChatDetails(LiveChatSuperChatDetails superChatDetails)

Details about the Super Chat event, this is only set if the type is 'superChatEvent'.

Parameters:

superChatDetails - superChatDetails or null for none

getSuperStickerDetails

public LiveChatSuperStickerDetails getSuperStickerDetails()

Details about the Super Sticker event, this is only set if the type is 'superStickerEvent'.

Returns:

value or null for none

setSuperStickerDetails

public LiveChatMessageSnippet setSuperStickerDetails(LiveChatSuperStickerDetails superStickerDetails)

Details about the Super Sticker event, this is only set if the type is 'superStickerEvent'.

Parameters:

superStickerDetails - superStickerDetails or null for none

getTextMessageDetails

public LiveChatTextMessageDetails getTextMessageDetails()

Details about the text message, this is only set if the type is 'textMessageEvent'.

Returns:

value or null for none

setTextMessageDetails

public LiveChatMessageSnippet setTextMessageDetails(LiveChatTextMessageDetails textMessageDetails)

Details about the text message, this is only set if the type is 'textMessageEvent'.

Parameters:

textMessageDetails - textMessageDetails or null for none

getType

public String getType()

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

Returns:

value or null for none

setType

public LiveChatMessageSnippet setType(String type)

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

Parameters:

type - type or null for none

getUserBannedDetails

public LiveChatUserBannedMessageDetails getUserBannedDetails()

Returns:

value or null for none

setUserBannedDetails

public LiveChatMessageSnippet setUserBannedDetails(LiveChatUserBannedMessageDetails userBannedDetails)

Parameters:

userBannedDetails - userBannedDetails or null for none

set

public LiveChatMessageSnippet set(String fieldName,
                                  Object value)

Overrides:

set in class GenericJson

clone

public LiveChatMessageSnippet clone()

Overrides:

clone in class GenericJson