java.lang.Object

com.gmt2001.twitch.eventsub.EventSubSubscriptionType

com.gmt2001.twitch.eventsub.subscriptions.channel.prediction.PredictionBegin

All Implemented Interfaces:: Flow.Subscriber<EventSubInternalEvent>

public final class PredictionBegin extends EventSubSubscriptionType

A Prediction started on a specified channel.

Author:: gmt2001

Field Summary

Fields

Modifier and Type

Field

Description

static final String

TYPE

static final String

VERSION

Fields inherited from class com.gmt2001.twitch.eventsub.EventSubSubscriptionType
flowsubscription, messageId, messageTimestamp, subscription
Constructor Summary

Constructors

Constructor

Description

PredictionBegin()

Only used by EventSub for handler registration

PredictionBegin(EventSubInternalNotificationEvent e)

Used by onEventSubInternalNotificationEvent(com.gmt2001.twitch.eventsub.EventSubInternalNotificationEvent) to construct an object from an incoming notification

PredictionBegin(String broadcaster_user_id)

Constructor
Method Summary

Modifier and Type

Method

Description

String

broadcasterUserId()

The broadcaster's user ID.

String

broadcasterUserLogin()

The broadcaster's user login.

String

broadcasterUserName()

The broadcaster's user display name.

String

id()

Channel Points Prediction ID.

protected boolean

isMatch(EventSubSubscription subscription)

Returns true if the provided subscription is an instance of the current subscription type and matches the current subscription conditions

ZonedDateTime

locksAt()

The time the Channel Points Prediction will automatically lock.

String

locksAtString()

The time the Channel Points Prediction will automatically lock as a string.

protected void

onEventSubInternalNotificationEvent(EventSubInternalNotificationEvent e)

List<PredictionOutcome>

outcomes()

A list of potential outcomes for the Channel Points Prediction.

protected EventSubSubscription

proposeSubscription()

Compiles the parameters of this object into an EventSubSubscription that can be created

ZonedDateTime

startedAt()

The time the Channel Points Prediction started.

String

startedAtString()

The time the Channel Points Prediction started as a string.

String

title()

Title for the Channel Points Prediction.

protected void

validateParameters()

Validates that the provided parameters are acceptable for use in EventSubSubscriptionType.proposeSubscription()

Methods inherited from class com.gmt2001.twitch.eventsub.EventSubSubscriptionType
create, delete, deleteAll, findMatchingSubscriptionId, findMatchingSubscriptionIds, getExistingSubscription, isAlreadySubscribed, messageId, messageTimestamp, onComplete, onError, onEventSubInternalEvent, onEventSubInternalRevocationEvent, onEventSubInternalVerificationEvent, onNext, onSubscribe, proposeSubscriptionInternal, proposeTransport, subscribe, subscription

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- TYPE
  
  public static final String TYPE
  See Also:
  
  Constant Field Values
- VERSION
  
  public static final String VERSION
  See Also:
  
  Constant Field Values
Constructor Details
- PredictionBegin
  
  public PredictionBegin()
  
  Only used by EventSub for handler registration
- PredictionBegin
  
  public PredictionBegin(EventSubInternalNotificationEvent e)
  
  Used by onEventSubInternalNotificationEvent(com.gmt2001.twitch.eventsub.EventSubInternalNotificationEvent) to construct an object from an incoming notification
  
  Parameters:
  
  e - The event
- PredictionBegin
  
  public PredictionBegin(String broadcaster_user_id)
  
  Constructor
  
  Parameters:
  
  broadcaster_user_id - The user id of the broadcaster
Method Details
- proposeSubscription
  
  protected EventSubSubscription proposeSubscription()
  
  Description copied from class: EventSubSubscriptionType
  
  Compiles the parameters of this object into an EventSubSubscription that can be created
  
  Specified by:
  
  proposeSubscription in class EventSubSubscriptionType
  
  Returns:
- validateParameters
  
  protected void validateParameters() throws IllegalArgumentException
  
  Description copied from class: EventSubSubscriptionType
  
  Validates that the provided parameters are acceptable for use in EventSubSubscriptionType.proposeSubscription()
  
  Specified by:
  
  validateParameters in class EventSubSubscriptionType
  
  Throws:
  
  IllegalArgumentException - One of the parameters is not acceptable
- onEventSubInternalNotificationEvent
  
  protected void onEventSubInternalNotificationEvent(EventSubInternalNotificationEvent e)
  
  Overrides:
  
  onEventSubInternalNotificationEvent in class EventSubSubscriptionType
- isMatch
  
  protected boolean isMatch(EventSubSubscription subscription)
  
  Description copied from class: EventSubSubscriptionType
  
  Returns true if the provided subscription is an instance of the current subscription type and matches the current subscription conditions
  
  Specified by:
  
  isMatch in class EventSubSubscriptionType
  
  Returns:
- broadcasterUserId
  
  public String broadcasterUserId()
  
  The broadcaster's user ID.
  
  Returns:
- broadcasterUserLogin
  
  public String broadcasterUserLogin()
  
  The broadcaster's user login.
  
  Returns:
- broadcasterUserName
  
  public String broadcasterUserName()
  
  The broadcaster's user display name.
  
  Returns:
- id
  
  public String id()
  
  Channel Points Prediction ID.
  
  Returns:
- title
  
  public String title()
  
  Title for the Channel Points Prediction.
  
  Returns:
- startedAtString
  
  public String startedAtString()
  
  The time the Channel Points Prediction started as a string.
  
  Returns:
- locksAtString
  
  public String locksAtString()
  
  The time the Channel Points Prediction will automatically lock as a string.
  
  Returns:
- startedAt
  
  public ZonedDateTime startedAt()
  
  The time the Channel Points Prediction started.
  
  Returns:
- locksAt
  
  public ZonedDateTime locksAt()
  
  The time the Channel Points Prediction will automatically lock.
  
  Returns:
- outcomes
  
  public List<PredictionOutcome> outcomes()
  
  A list of potential outcomes for the Channel Points Prediction.
  
  Returns:

Class PredictionBegin

Field Summary

Fields inherited from class com.gmt2001.twitch.eventsub.EventSubSubscriptionType

Constructor Summary

Method Summary

Methods inherited from class com.gmt2001.twitch.eventsub.EventSubSubscriptionType

Methods inherited from class java.lang.Object

Field Details

TYPE

VERSION

Constructor Details

PredictionBegin

PredictionBegin

PredictionBegin

Method Details

proposeSubscription

validateParameters

onEventSubInternalNotificationEvent

isMatch

broadcasterUserId

broadcasterUserLogin

broadcasterUserName

id

title

startedAtString

locksAtString

startedAt

locksAt

outcomes