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

Class ModAnnouncementEvent

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.channel.ModAnnouncementEvent

All Implemented Interfaces:

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

@Unofficial
public final class ModAnnouncementEvent
extends AbstractChannelEvent
implements MirrorableEvent

Fired when the broadcaster or a moderator publishes an accented message via /announce.

Since this event is not officially documented in the IRC guide, it could change or stop working at any time.

See Also:

• Official Announcement

Constructor Summary

Constructors

Constructor	Description
ModAnnouncementEvent(IRCMessageEvent messageEvent, EventChannel channel, EventUser announcer, String message, AnnouncementColor color)	Event Constructor

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
AnnouncementColor	getAccentColor()	The color accent for the announcement.
EventUser	getAnnouncer()	The user that made the announcement.
AnnouncementColor	getColor()	Deprecated. in favor of getAccentColor()
String	getMessage()	The message being announced.
IRCMessageEvent	getMessageEvent()	The raw message event.
int	hashCode()
String	toString()

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

Constructor Details

ModAnnouncementEvent

@Internal
public ModAnnouncementEvent(IRCMessageEvent messageEvent,
 EventChannel channel,
 EventUser announcer,
 String message,
 AnnouncementColor color)

Event Constructor

Parameters:

messageEvent - The raw message event.

channel - The channel that this event originates from.

announcer - The user that made the announcement.

message - The message being announced.

color - The color accent for the announcement.

Method Details

getColor

@Deprecated
public AnnouncementColor getColor()

Deprecated.

in favor of getAccentColor()

Returns:

the color accent for the announcement.

getMessageEvent

public IRCMessageEvent getMessageEvent()

The raw message event.

Specified by:

getMessageEvent in interface MirrorableEvent

Returns:

the raw message event

getAnnouncer

public EventUser getAnnouncer()

The user that made the announcement.

getMessage

public String getMessage()

The message being announced.

getAccentColor

public AnnouncementColor getAccentColor()

The color accent for the announcement.

toString

public String toString()

Overrides:

toString in class AbstractChannelEvent

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractChannelEvent

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class AbstractChannelEvent

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractChannelEvent