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

Class ChannelStateEvent

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.ChannelStateEvent

All Implemented Interfaces:

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

public final class ChannelStateEvent
extends AbstractChannelEvent

Called upon successfully joining a channel, or when a moderator updates a public chat room setting.

This event corresponds to ROOMSTATE over IRC.

When inspecting the updated setting values, it is easier to utilize these individual events: EmoteOnlyEvent, FollowersOnlyEvent, Robot9000Event, SlowModeEvent, SubscribersOnlyEvent.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ChannelStateEvent.ChannelState	The possible chat room settings that can be configured.

Constructor Summary

Constructors

Constructor	Description
ChannelStateEvent(EventChannel channel, ChannelStateEvent.ChannelState state, Object value)	Deprecated. unused by Twitch4J
ChannelStateEvent(EventChannel channel, Map<ChannelStateEvent.ChannelState,Object> states)	Event Constructor

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
@Nullable Object	getState(@NotNull ChannelStateEvent.ChannelState state)
Map<ChannelStateEvent.ChannelState,Object>	getStates()	Contains the singular chat room setting that was updated (or all chat room settings upon joining the channel).
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

Constructor Details

ChannelStateEvent

@Deprecated
public ChannelStateEvent(EventChannel channel,
 ChannelStateEvent.ChannelState state,
 Object value)

Deprecated.

unused by Twitch4J

Event Constructor

Parameters:

channel - The channel that this event originates from.

state - The changed state triggering the event

value - The value representing the state

ChannelStateEvent

public ChannelStateEvent(EventChannel channel,
 Map<ChannelStateEvent.ChannelState,Object> states)

Event Constructor

Parameters:

channel - The channel that this event originates from.

states - The chat room settings.

Method Details

getState

@Nullable
public @Nullable Object getState(@NotNull
 @NotNull ChannelStateEvent.ChannelState state)

Parameters:

state - a chat room setting to query

Returns:

the latest value for the setting if it was just adjusted

getStates

public Map<ChannelStateEvent.ChannelState,Object> getStates()

Contains the singular chat room setting that was updated (or all chat room settings upon joining the channel).

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