Package com.github.twitch4j.helix.domain

Class Prediction.PredictionBuilder

java.lang.Object

com.github.twitch4j.helix.domain.Prediction.PredictionBuilder

Enclosing class:

Prediction

public static class Prediction.PredictionBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
Prediction.PredictionBuilder	broadcasterId(String broadcasterId)	ID of the broadcaster.
Prediction.PredictionBuilder	broadcasterLogin(String broadcasterLogin)	Login name of the broadcaster.
Prediction.PredictionBuilder	broadcasterName(String broadcasterName)	Display name of the broadcaster.
Prediction	build()
Prediction.PredictionBuilder	clearOutcomes()
Prediction.PredictionBuilder	createdAt(Instant createdAt)	UTC timestamp for the Prediction’s start time.
Prediction.PredictionBuilder	endedAt(@Nullable Instant endedAt)	UTC timestamp for when the Prediction ended.
Prediction.PredictionBuilder	id(String id)	ID of the Prediction.
Prediction.PredictionBuilder	lockedAt(@Nullable Instant lockedAt)	UTC timestamp for when the Prediction was locked.
Prediction.PredictionBuilder	outcome(PredictionOutcome outcome)
Prediction.PredictionBuilder	outcomes(Collection<? extends PredictionOutcome> outcomes)
Prediction.PredictionBuilder	predictionWindowSeconds(Integer predictionWindowSeconds)	Total duration for the Prediction (in seconds).
Prediction.PredictionBuilder	status(PredictionStatus status)	Status of the Prediction.
Prediction.PredictionBuilder	title(String title)	Title for the Prediction.
String	toString()
Prediction.PredictionBuilder	winningOutcomeId(@Nullable String winningOutcomeId)	ID of the winning outcome.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

id

public Prediction.PredictionBuilder id(String id)

ID of the Prediction.

Returns:

this.

broadcasterId

public Prediction.PredictionBuilder broadcasterId(String broadcasterId)

ID of the broadcaster.

Returns:

this.

broadcasterName

public Prediction.PredictionBuilder broadcasterName(String broadcasterName)

Display name of the broadcaster.

Returns:

this.

broadcasterLogin

public Prediction.PredictionBuilder broadcasterLogin(String broadcasterLogin)

Login name of the broadcaster.

Returns:

this.

title

public Prediction.PredictionBuilder title(String title)

Title for the Prediction. Maximum: 45 characters.

Returns:

this.

winningOutcomeId

public Prediction.PredictionBuilder winningOutcomeId(@Nullable
 @Nullable String winningOutcomeId)

ID of the winning outcome. If the status is ACTIVE, this is set to null.

Returns:

this.

outcome

public Prediction.PredictionBuilder outcome(PredictionOutcome outcome)

outcomes

public Prediction.PredictionBuilder outcomes(Collection<? extends PredictionOutcome> outcomes)

clearOutcomes

public Prediction.PredictionBuilder clearOutcomes()

predictionWindowSeconds

public Prediction.PredictionBuilder predictionWindowSeconds(Integer predictionWindowSeconds)

Total duration for the Prediction (in seconds). Minimum: 1. Maximum: 1800.

Returns:

this.

status

public Prediction.PredictionBuilder status(PredictionStatus status)

Status of the Prediction.

Returns:

this.

createdAt

public Prediction.PredictionBuilder createdAt(Instant createdAt)

UTC timestamp for the Prediction’s start time.

Returns:

this.

endedAt

public Prediction.PredictionBuilder endedAt(@Nullable
 @Nullable Instant endedAt)

UTC timestamp for when the Prediction ended. If the status is ACTIVE, this is set to null.

Returns:

this.

lockedAt

public Prediction.PredictionBuilder lockedAt(@Nullable
 @Nullable Instant lockedAt)

UTC timestamp for when the Prediction was locked. If the status is not LOCKED, this is set to null.

Returns:

this.

build

public Prediction build()

toString

public String toString()

Overrides:

toString in class Object