Package com.github.twitch4j.eventsub.domain

Enum Class PredictionStatus

java.lang.Object

java.lang.Enum<PredictionStatus>

com.github.twitch4j.eventsub.domain.PredictionStatus

All Implemented Interfaces:

Serializable, Comparable<PredictionStatus>, Constable

public enum PredictionStatus
extends Enum<PredictionStatus>

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
ACTIVE	The Prediction is active and viewers can make predictions.
CANCELED	The Prediction has been canceled and the Channel Points have been refunded to participants.
LOCKED	The Prediction has been locked and viewers can no longer make predictions.
RESOLVED	A winning outcome has been chosen and the Channel Points have been distributed to the users who guessed the correct outcome.

Method Summary

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

RESOLVED

public static final PredictionStatus RESOLVED

A winning outcome has been chosen and the Channel Points have been distributed to the users who guessed the correct outcome.

ACTIVE

public static final PredictionStatus ACTIVE

The Prediction is active and viewers can make predictions.

CANCELED

public static final PredictionStatus CANCELED

The Prediction has been canceled and the Channel Points have been refunded to participants.

LOCKED

public static final PredictionStatus LOCKED

The Prediction has been locked and viewers can no longer make predictions.

Method Details

values

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