Package com.github.twitch4j.eventsub.subscriptions

Class HypeTrainBeginType

java.lang.Object

com.github.twitch4j.eventsub.subscriptions.HypeTrainBeginType

All Implemented Interfaces:

SubscriptionType<HypeTrainBeginCondition,HypeTrainBeginCondition.HypeTrainBeginConditionBuilder<?,?>,HypeTrainBeginEvent>

public class HypeTrainBeginType
extends Object
implements SubscriptionType<HypeTrainBeginCondition,HypeTrainBeginCondition.HypeTrainBeginConditionBuilder<?,?>,HypeTrainBeginEvent>

A hype train begins on the specified channel.

Must have channel:read:hype_train scope.

EventSub does not make strong assurances about the order of message delivery, so it is possible to receive progress notifications before you receive the corresponding begin notification.

Constructor Summary

Constructors

Constructor	Description
HypeTrainBeginType()

Method Summary

Modifier and Type	Method	Description
HypeTrainBeginCondition.HypeTrainBeginConditionBuilder<?,?>	getConditionBuilder()	The parameters inside these objects differ by subscription type and may differ by version.
Class<HypeTrainBeginEvent>	getEventClass()
String	getName()
String	getVersion()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.twitch4j.eventsub.subscriptions.SubscriptionType

getConditionClass, isBatchingEnabled, prepareSubscription

Constructor Details

HypeTrainBeginType

public HypeTrainBeginType()

Method Details

getName

public String getName()

Specified by:

getName in interface SubscriptionType<HypeTrainBeginCondition,HypeTrainBeginCondition.HypeTrainBeginConditionBuilder<?,?>,HypeTrainBeginEvent>

Returns:

the subscription type name.

getVersion

public String getVersion()

Specified by:

getVersion in interface SubscriptionType<HypeTrainBeginCondition,HypeTrainBeginCondition.HypeTrainBeginConditionBuilder<?,?>,HypeTrainBeginEvent>

Returns:

the subscription type version.

getConditionBuilder

public HypeTrainBeginCondition.HypeTrainBeginConditionBuilder<?,?> getConditionBuilder()

Description copied from interface: SubscriptionType

The parameters inside these objects differ by subscription type and may differ by version.

Specified by:

getConditionBuilder in interface SubscriptionType<HypeTrainBeginCondition,HypeTrainBeginCondition.HypeTrainBeginConditionBuilder<?,?>,HypeTrainBeginEvent>

Returns:

Subscription-specific parameter builder.

getEventClass

public Class<HypeTrainBeginEvent> getEventClass()

Specified by:

getEventClass in interface SubscriptionType<HypeTrainBeginCondition,HypeTrainBeginCondition.HypeTrainBeginConditionBuilder<?,?>,HypeTrainBeginEvent>

Returns:

the associated event class for this subscription type.