Package com.github.twitch4j.common.enums

Enum Class TwitchLimitType

java.lang.Object

java.lang.Enum<TwitchLimitType>

com.github.twitch4j.common.enums.TwitchLimitType

All Implemented Interfaces:

Serializable, Comparable<TwitchLimitType>, Constable

public enum TwitchLimitType
extends Enum<TwitchLimitType>

The types of rate-limits imposed by Twitch.

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
CHAT_AUTH_LIMIT	How fast authentication attempts can be issued over IRC.
CHAT_JOIN_LIMIT	How fast channel join attempts can be issued over IRC.
CHAT_MESSAGE_LIMIT	How fast messages can be issued over IRC.
CHAT_WHISPER_LIMIT	How fast private messages can be issued over IRC.
HELIX_AUTOMOD_STATUS_LIMIT	How fast Check AutoMod Status can be called per channel via Helix.

Method Summary

Modifier and Type	Method	Description
String	getBandwidthId()	The identifier for the related bandwidth slot in a bucket for smoother replacement.
static TwitchLimitType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TwitchLimitType[]	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

CHAT_AUTH_LIMIT

public static final TwitchLimitType CHAT_AUTH_LIMIT

How fast authentication attempts can be issued over IRC.

CHAT_JOIN_LIMIT

public static final TwitchLimitType CHAT_JOIN_LIMIT

How fast channel join attempts can be issued over IRC.

CHAT_MESSAGE_LIMIT

public static final TwitchLimitType CHAT_MESSAGE_LIMIT

How fast messages can be issued over IRC.

CHAT_WHISPER_LIMIT

public static final TwitchLimitType CHAT_WHISPER_LIMIT

How fast private messages can be issued over IRC.

HELIX_AUTOMOD_STATUS_LIMIT

public static final TwitchLimitType HELIX_AUTOMOD_STATUS_LIMIT

How fast Check AutoMod Status can be called per channel via Helix.

See Also:

• Twitch Announcement

Method Details

values

public static TwitchLimitType[] 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 TwitchLimitType 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

getBandwidthId

public String getBandwidthId()

The identifier for the related bandwidth slot in a bucket for smoother replacement.