Package com.github.twitch4j.eventsub.domain

Enum Class HypeTrainType

java.lang.Object

java.lang.Enum<HypeTrainType>

com.github.twitch4j.eventsub.domain.HypeTrainType

All Implemented Interfaces:

Serializable, Comparable<HypeTrainType>, Constable

public enum HypeTrainType
extends Enum<HypeTrainType>

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
GOLDEN_KAPPA	A golden kappa hype train (i.e., contributors get the golden kappa emote for 24 hours).
REGULAR	A regular hype train (i.e., each level has hype emote rewards).
TREASURE	A treasure train (i.e., discounted gift subs if a sufficient level is reached).

Method Summary

Modifier and Type	Method	Description
static HypeTrainType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HypeTrainType[]	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

TREASURE

@Experimental
public static final HypeTrainType TREASURE

A treasure train (i.e., discounted gift subs if a sufficient level is reached).

See Also:

• Experiment Announcement

GOLDEN_KAPPA

public static final HypeTrainType GOLDEN_KAPPA

A golden kappa hype train (i.e., contributors get the golden kappa emote for 24 hours).

See Also:

• Official Explainer

REGULAR

public static final HypeTrainType REGULAR

A regular hype train (i.e., each level has hype emote rewards).

See Also:

• Official Help Guide

Method Details

values

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