Package com.github.twitch4j.chat.events.channel

Klasse IRCMessageEvent

java.lang.Object

com.github.philippheuer.events4j.core.domain.Event

com.github.twitch4j.chat.events.TwitchEvent

com.github.twitch4j.chat.events.channel.IRCMessageEvent

Alle implementierten Schnittstellen:

com.github.philippheuer.events4j.api.domain.IEvent

public class IRCMessageEvent
extends TwitchEvent

This event gets called when we receive a raw irc message.

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
static final String	NONCE_TAG_NAME

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
IRCMessageEvent(@NotNull String rawMessage, @NotNull Map<String,CharSequence> escapedTags, CharSequence clientName, @NotNull String commandType, @Nullable String channelName, @Nullable CharSequence payload, @Nullable String message, @NotNull Map<String,String> channelIdToChannelName, @NotNull Map<String,String> channelNameToChannelId, @Nullable Collection<String> botOwnerIds)
IRCMessageEvent(String rawMessage, Map<String,String> channelIdToChannelName, Map<String,String> channelNameToChannelId, Collection<String> botOwnerIds)	Veraltet. Use MessageParser.parse(String, Map, Map, Collection) to create IRCMessageEvent instances

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Map<String,String>	getBadgeInfo()
Map<String,String>	getBadges()
EventChannel	getChannel()	Get ChatChannel
String	getChannelId()	Channel Id
Optional<String>	getChannelName()
OptionalInt	getCheererTier()
Optional<String>	getClientName()
Set<CommandPermission>	getClientPermissions()
String	getCommandType()	Message Type
Map<String,CharSequence>	getEscapedTags()	Tags
List<AutoModFlag>	getFlags()	AutoMod Message Flag Indicators, relevant for PRIVMSG and USERNOTICE
Optional<String>	getMessage()
Optional<String>	getMessageId()	The message UUID that is used for deletion by a moderator or a chat reply (from Tags)
Optional<String>	getNonce()
Optional<String>	getPayload()
OptionalInt	getPredictedChoiceIndex()
Optional<String>	getPredictedChoiceTitle()
String	getRawMessage()	RAW Message
@Nullable CharSequence	getRawTag(@NotNull String name)
Map<String,Object>	getRawTags()	Veraltet. in favor of getEscapedTags()
@Nullable String	getRawTagString(@NotNull String name)
OptionalInt	getSubscriberMonths()
OptionalInt	getSubscriptionTier()
Map<String,String>	getTags()	Veraltet. in favor of getTagValue(String) or getEscapedTags()
Optional<String>	getTagValue(String tagName)	Gets a optional tag from the irc message
EventUser	getTargetUser()	Get Target User
String	getTargetUserId()	Gets the Target User Id (from Tags)
EventUser	getUser()	Get User
Optional<String>	getUserChatColor()
Optional<String>	getUserDisplayName()
String	getUserId()	Gets the User Id (from Tags)
String	getUserName()	Gets the User Name (from Tags)
int	hashCode()
Boolean	isValid()	Veraltet. MessageParser.parse(String) yields null for invalid messages
static Optional<String>	parseClientName(String raw)	Veraltet. This method is no longer used by twitch4j
static Map<String,CharSequence>	parseTags(String raw)	Veraltet. This method is no longer used by twitch4j
String	toString()

Von Klasse geerbte Methoden com.github.twitch4j.chat.events.TwitchEvent

getTwitchChat

Von Klasse geerbte Methoden com.github.philippheuer.events4j.core.domain.Event

getEventId, getFiredAt, getFiredAtInstant, getServiceMediator, setEventId, setFiredAt, setFiredAtInstant, setServiceMediator

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

NONCE_TAG_NAME

@Unofficial
public static final String NONCE_TAG_NAME

Siehe auch:

• Konstantenfeldwerte

Konstruktordetails

IRCMessageEvent

@Internal
public IRCMessageEvent(@NotNull
 @NotNull String rawMessage,
 @NotNull
 @NotNull Map<String,CharSequence> escapedTags,
 CharSequence clientName,
 @NotNull
 @NotNull String commandType,
 @Nullable
 @Nullable String channelName,
 @Nullable
 @Nullable CharSequence payload,
 @Nullable
 @Nullable String message,
 @NotNull
 @NotNull Map<String,String> channelIdToChannelName,
 @NotNull
 @NotNull Map<String,String> channelNameToChannelId,
 @Nullable
 @Nullable Collection<String> botOwnerIds)

IRCMessageEvent

@Deprecated
public IRCMessageEvent(String rawMessage,
 Map<String,String> channelIdToChannelName,
 Map<String,String> channelNameToChannelId,
 Collection<String> botOwnerIds)

Veraltet.

Use MessageParser.parse(String, Map, Map, Collection) to create IRCMessageEvent instances

Event Constructor

Parameter:

rawMessage - The raw message.

channelIdToChannelName - Mapping used to lookup a missing channel name in the event

channelNameToChannelId - Mapping used to lookup a missing channel id in the event

botOwnerIds - The bot owner ids.

Methodendetails

getBadgeInfo

public Map<String,String> getBadgeInfo()

Gibt zurück:

metadata related to the chat badges in the badges tag

getBadges

public Map<String,String> getBadges()

Gibt zurück:

the visible chat badges parsed from tags

getClientPermissions

public Set<CommandPermission> getClientPermissions()

Gibt zurück:

the permissions of the client that sent this message, based on visible badges

isValid

@Deprecated
public Boolean isValid()

Veraltet.

MessageParser.parse(String) yields null for invalid messages

Checks if the Event was parsed correctly.

Gibt zurück:

Is the Event valid?

parseTags

@Deprecated
@ScheduledForRemoval(inVersion="2.0.0")
public static Map<String,CharSequence> parseTags(String raw)

Veraltet.

This method is no longer used by twitch4j

Parse Tags from raw list

Parameter:

raw - The raw list of tags.

Gibt zurück:

A key-value map of the tags.

parseClientName

@Deprecated
@ScheduledForRemoval(inVersion="2.0.0")
public static Optional<String> parseClientName(String raw)

Veraltet.

This method is no longer used by twitch4j

Gets the ClientName from the IRC User Identifier (:user!user@user.tmi.twitch.tv)

Parameter:

raw - Raw ClientName

Gibt zurück:

Client name, or empty.

getUserId

public String getUserId()

Gets the User Id (from Tags)

Gibt zurück:

Long userId

getUserName

public String getUserName()

Gets the User Name (from Tags)

Gibt zurück:

String userName

getUserDisplayName

public Optional<String> getUserDisplayName()

Gibt zurück:

the display name of the user who sent this message, if applicable

getUserChatColor

public Optional<String> getUserChatColor()

Gibt zurück:

hexadecimal RGB color code of the user's chat color, or empty if it is never set.

getTargetUserId

public String getTargetUserId()

Gets the Target User Id (from Tags)

Gibt zurück:

Long targetUserId

getMessageId

public Optional<String> getMessageId()

The message UUID that is used for deletion by a moderator or a chat reply (from Tags)

Gibt zurück:

the unique ID for the message

getNonce

@Unofficial
public Optional<String> getNonce()

Gibt zurück:

the client nonce for the message.

getSubscriberMonths

public OptionalInt getSubscriberMonths()

Gibt zurück:

the exact number of months the user has been a subscriber, or empty if they are not subscribed

getSubscriptionTier

public OptionalInt getSubscriptionTier()

Gibt zurück:

the tier at which the user is subscribed, or empty if they are not subscribed or have the founders badge equipped

getCheererTier

public OptionalInt getCheererTier()

Gibt zurück:

the tier of the bits badge of the user, or empty if there is no bits badge present (which can also occur for bits leaders)

getPredictedChoiceIndex

public OptionalInt getPredictedChoiceIndex()

Gibt zurück:

the index of the choice this user is predicting, in an optional wrapper

getPredictedChoiceTitle

public Optional<String> getPredictedChoiceTitle()

Gibt zurück:

the title of the choice this user is predicting, in an optional wrapper

getTagValue

public Optional<String> getTagValue(String tagName)

Gets a optional tag from the irc message

Parameter:

tagName - The tag of the irc message

Gibt zurück:

String tagValue

getUser

public EventUser getUser()

Get User

Gibt zurück:

ChatUser

getTargetUser

public EventUser getTargetUser()

Get Target User

Gibt zurück:

ChatUser

getChannel

public EventChannel getChannel()

Get ChatChannel

Gibt zurück:

ChatChannel

getChannelName

public Optional<String> getChannelName()

Gibt zurück:

the channel name associated with this event, if applicable

getPayload

public Optional<String> getPayload()

Gibt zurück:

IRC message payload, which includes a colon prefix, unlike getMessage()

getMessage

public Optional<String> getMessage()

Gibt zurück:

the message sent by a user to an IRC channel

getClientName

public Optional<String> getClientName()

Gibt zurück:

the client name associated with the message, excluding the hostname

getRawTag

@Nullable
@Internal
public @Nullable CharSequence getRawTag(@NotNull
 @NotNull String name)

Parameter:

name - the tag key

Gibt zurück:

the (not escaped) tag value associated with the specified key, in CharSequence form

getRawTagString

@Nullable
@Internal
public @Nullable String getRawTagString(@NotNull
 @NotNull String name)

Parameter:

name - the tag key

Gibt zurück:

the (not escaped) tag value associated with the specified key, in String form

getTags

@Deprecated
public Map<String,String> getTags()

Veraltet.

in favor of getTagValue(String) or getEscapedTags()

Gibt zurück:

raw (i.e., not unescaped) IRCv3 tags

getRawTags

@Deprecated
public Map<String,Object> getRawTags()

Veraltet.

in favor of getEscapedTags()

Gibt zurück:

IRCv3 tags

toString

public String toString()

Setzt außer Kraft:

toString in Klasse TwitchEvent

getEscapedTags

public Map<String,CharSequence> getEscapedTags()

Tags

Most applications should utilize getTagValue(String) rather than accessing this map directly.

getCommandType

public String getCommandType()

Message Type

getChannelId

public String getChannelId()

Channel Id

getRawMessage

public String getRawMessage()

RAW Message

equals

public boolean equals(Object o)

Setzt außer Kraft:

equals in Klasse TwitchEvent

canEqual

protected boolean canEqual(Object other)

Setzt außer Kraft:

canEqual in Klasse TwitchEvent

hashCode

public int hashCode()

Setzt außer Kraft:

hashCode in Klasse TwitchEvent

getFlags

public List<AutoModFlag> getFlags()

AutoMod Message Flag Indicators, relevant for PRIVMSG and USERNOTICE