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

Enum Class ChannelJoinFailureEvent.Reason

java.lang.Object

java.lang.Enum<ChannelJoinFailureEvent.Reason>

com.github.twitch4j.chat.events.channel.ChannelJoinFailureEvent.Reason

All Implemented Interfaces:

Serializable, Comparable<ChannelJoinFailureEvent.Reason>, Constable

Enclosing class:

ChannelJoinFailureEvent

public static enum ChannelJoinFailureEvent.Reason
extends Enum<ChannelJoinFailureEvent.Reason>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CHANNEL_SUSPENDED	The channel was suspended, so further chat messages cannot be received.
RETRIES_EXHAUSTED	The chat instance was unable to join the channel, exhausting maxJoinRetries.
USER_BANNED	The chat user was banned from an initially successfully joined channel.

Method Summary

Modifier and Type	Method	Description
static ChannelJoinFailureEvent.Reason	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ChannelJoinFailureEvent.Reason[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

RETRIES_EXHAUSTED

public static final ChannelJoinFailureEvent.Reason RETRIES_EXHAUSTED

The chat instance was unable to join the channel, exhausting maxJoinRetries. Since removeChannelOnJoinFailure was enabled, the channel was removed.

This can occur when the channel simply does not exist or the user was already banned from the channel.

USER_BANNED

public static final ChannelJoinFailureEvent.Reason USER_BANNED

The chat user was banned from an initially successfully joined channel.

Twitch does not send this state upon initially joining a channel, if the user is already banned.

CHANNEL_SUSPENDED

public static final ChannelJoinFailureEvent.Reason CHANNEL_SUSPENDED

The channel was suspended, so further chat messages cannot be received.

This can be sent upon initial join (if the channel was already suspended) or even after a successful initial join (the channel was not initially suspended).

Method Details

values

public static ChannelJoinFailureEvent.Reason[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ChannelJoinFailureEvent.Reason valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null