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

Class ChannelMessageEvent

java.lang.Object

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

com.github.twitch4j.chat.events.TwitchEvent

com.github.twitch4j.chat.events.AbstractChannelEvent

com.github.twitch4j.chat.events.AbstractChannelMessageEvent

com.github.twitch4j.chat.events.channel.ChannelMessageEvent

All Implemented Interfaces:

com.github.philippheuer.events4j.api.domain.IEvent, MirrorableEvent, ReplyableEvent

public final class ChannelMessageEvent
extends AbstractChannelMessageEvent

This event gets called when a message is received in a channel.

Constructor Summary

Constructors

Constructor	Description
ChannelMessageEvent(EventChannel channel, IRCMessageEvent messageEvent, EventUser user, String message)	Event Constructor

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Optional<String>	getAnimationId()
@Nullable ChatCrowdChant	getChantInfo()	Deprecated. Will be disabled on 2022-02-02
Optional<String>	getCustomRewardId()
Optional<DonationAmount>	getElevatedChatPayment()	Hype Chat Contribution
Optional<HypeChatLevel>	getHypeChatLevel()
@Nullable ChatReply	getReplyInfo()	Information regarding the parent message being replied to, if applicable.
boolean	hasGiganticEmote()
int	hashCode()
boolean	hasMessageEffects()
boolean	isDesignatedFirstMessage()
boolean	isHighlightedMessage()
boolean	isSkipSubsModeMessage()
boolean	isUserIntroduction()
String	toString()

Methods inherited from class com.github.twitch4j.chat.events.AbstractChannelMessageEvent

getFlags, getMessage, getMessageEvent, getNonce, getPermissions, getSubscriberMonths, getSubscriptionTier, getUser, isSourceOnly

Methods inherited from class com.github.twitch4j.chat.events.AbstractChannelEvent

ban, getChannel, timeout, unban

Methods inherited from class com.github.twitch4j.chat.events.TwitchEvent

getTwitchChat

Methods inherited from class com.github.philippheuer.events4j.core.domain.Event

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.twitch4j.chat.events.channel.MirrorableEvent

getSourceBadgeInfo, getSourceBadges, getSourceChannelId, getSourceMessageId, getSourceNoticeType, isMirrored

Methods inherited from interface com.github.twitch4j.chat.events.channel.ReplyableEvent

getChannel, reply

Constructor Details

ChannelMessageEvent

public ChannelMessageEvent(EventChannel channel,
 IRCMessageEvent messageEvent,
 EventUser user,
 String message)

Event Constructor

Parameters:

channel - The channel that this event originates from.

messageEvent - The raw message event

user - The user who triggered the event.

message - The plain text of the message.

Method Details

isHighlightedMessage

@Unofficial
public boolean isHighlightedMessage()

Returns:

whether "Highlight My Message" was redeemed for this event

isSkipSubsModeMessage

@Unofficial
public boolean isSkipSubsModeMessage()

Returns:

whether "Send a Message in Sub-Only Mode" was redeemed for this event

getCustomRewardId

@Unofficial
public Optional<String> getCustomRewardId()

Returns:

the id for the custom reward that was redeemed with this associated message, in an optional wrapper

isDesignatedFirstMessage

@Unofficial
public boolean isDesignatedFirstMessage()

Returns:

whether this is the user's first message in the channel.

See Also:

• Official documentation

API Note:

This method is marked as unofficial since this tag does not appear in the irc guide.

isUserIntroduction

@Unofficial
public boolean isUserIntroduction()

Returns:

whether this message constitutes the user's designated introduction.

See Also:

• Twitch Announcement

API Note:

This method is unofficial since the experiment is not officially documented in the irc guide.

hasGiganticEmote

@Unofficial
public boolean hasGiganticEmote()

Returns:

whether the message is a "Gigantify an Emote" bits redemption

See Also:

• Twitch Announcement

API Note:

This method is unofficial since the msg-id is not documented in the irc guide.

hasMessageEffects

@Unofficial
public boolean hasMessageEffects()

Returns:

whether the message is a "Message Effects" bits redemption

See Also:

• Twitch Announcement

API Note:

This method is unofficial since the msg-id is not documented in the irc guide.

getAnimationId

@Unofficial
public Optional<String> getAnimationId()

Returns:

returns the animation id associated with the "Message Effects" bits redemption. Possible values include "cosmic-abyss", "simmer", and "rainbow-eclipse".

See Also:

• Twitch Announcement

API Note:

This method is unofficial since the tag is not documented in the irc guide.

getElevatedChatPayment

public Optional<DonationAmount> getElevatedChatPayment()

Hype Chat Contribution

Returns:

the payment information related to this hype chat, if applicable.

See Also:

• Twitch Announcement

getHypeChatLevel

public Optional<HypeChatLevel> getHypeChatLevel()

Returns:

the HypeChatLevel associated with the hype chat contribution.

See Also:

• getElevatedChatPayment()

toString

public String toString()

Overrides:

toString in class AbstractChannelMessageEvent

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractChannelMessageEvent

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class AbstractChannelMessageEvent

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractChannelMessageEvent

getReplyInfo

@Nullable
public @Nullable ChatReply getReplyInfo()

Information regarding the parent message being replied to, if applicable.

getChantInfo

@Deprecated
@Nullable
public @Nullable ChatCrowdChant getChantInfo()

Deprecated.

Will be disabled on 2022-02-02

Information regarding any associated Crowd Chant for this message, if applicable.