Package com.github.twitch4j.common.enums

Enum Class HypeChatLevel

java.lang.Object

java.lang.Enum<HypeChatLevel>

com.github.twitch4j.common.enums.HypeChatLevel

All Implemented Interfaces:

Serializable, Comparable<HypeChatLevel>, Constable

public enum HypeChatLevel
extends Enum<HypeChatLevel>

See Also:

• Official Help Article

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
EIGHT
FIVE
FOUR
NINE
ONE
SEVEN
SIX
TEN
THREE
TWO

Field Summary

Fields

Modifier and Type	Field	Description
static final Map<String,HypeChatLevel>	MAPPINGS

Method Summary

Modifier and Type	Method	Description
int	getCharacterLimit()
int	getLevel()
Duration	getPinDuration()	The amount of time the message is pinned to the top of chat.
boolean	hasGradient()
static HypeChatLevel	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HypeChatLevel[]	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

ONE

public static final HypeChatLevel ONE

TWO

public static final HypeChatLevel TWO

THREE

public static final HypeChatLevel THREE

FOUR

public static final HypeChatLevel FOUR

FIVE

public static final HypeChatLevel FIVE

SIX

public static final HypeChatLevel SIX

SEVEN

public static final HypeChatLevel SEVEN

EIGHT

public static final HypeChatLevel EIGHT

NINE

public static final HypeChatLevel NINE

TEN

public static final HypeChatLevel TEN

Field Details

MAPPINGS

@Internal
public static final Map<String,HypeChatLevel> MAPPINGS

Method Details

values

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

getLevel

public int getLevel()

Returns:

the level in integer form.

getCharacterLimit

public int getCharacterLimit()

Returns:

the maximum number of characters that can be in a hype chat message at this level.

hasGradient

public boolean hasGradient()

Returns:

whether the Hype Chat contribution has a colored gradient in the official chat interface.

getPinDuration

public Duration getPinDuration()

The amount of time the message is pinned to the top of chat.