Package com.github.twitch4j.eventsub.subscriptions

Class HypeTrainBeginV2Type

java.lang.Object

com.github.twitch4j.eventsub.subscriptions.HypeTrainBeginV2Type

All Implemented Interfaces:

SubscriptionType<ChannelEventSubCondition,ChannelEventSubCondition.ChannelEventSubConditionBuilder<?,?>,HypeTrainBeginV2Event>

public class HypeTrainBeginV2Type
extends Object
implements SubscriptionType<ChannelEventSubCondition,ChannelEventSubCondition.ChannelEventSubConditionBuilder<?,?>,HypeTrainBeginV2Event>

The channel.hype_train.begin subscription type sends a notification when a Hype Train begins on the specified channel.

In addition to a channel.hype_train.begin event, one channel.hype_train.progress event will be sent for each contribution that caused the Hype Train to begin.

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

After the Hype Train begins, any additional cheers or subscriptions on the channel will cause channel.hype_train.progress notifications to be sent. When the Hype Train is over, channel.hype_train.end is emitted.

Authorization: Must have channel:read:hype_train scope (from the broadcaster).

Constructor Summary

Constructors

Constructor	Description
HypeTrainBeginV2Type()

Method Summary

Modifier and Type	Method	Description
ChannelEventSubCondition.ChannelEventSubConditionBuilder<?,?>	getConditionBuilder()	The parameters inside these objects differ by subscription type and may differ by version.
Class<HypeTrainBeginV2Event>	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

HypeTrainBeginV2Type

public HypeTrainBeginV2Type()

Method Details

getName

public String getName()

Specified by:

getName in interface SubscriptionType<ChannelEventSubCondition,ChannelEventSubCondition.ChannelEventSubConditionBuilder<?,?>,HypeTrainBeginV2Event>

Returns:

the subscription type name.

getVersion

public String getVersion()

Specified by:

getVersion in interface SubscriptionType<ChannelEventSubCondition,ChannelEventSubCondition.ChannelEventSubConditionBuilder<?,?>,HypeTrainBeginV2Event>

Returns:

the subscription type version.

getConditionBuilder

public ChannelEventSubCondition.ChannelEventSubConditionBuilder<?,?> 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<ChannelEventSubCondition,ChannelEventSubCondition.ChannelEventSubConditionBuilder<?,?>,HypeTrainBeginV2Event>

Returns:

Subscription-specific parameter builder.

getEventClass

public Class<HypeTrainBeginV2Event> getEventClass()

Specified by:

getEventClass in interface SubscriptionType<ChannelEventSubCondition,ChannelEventSubCondition.ChannelEventSubConditionBuilder<?,?>,HypeTrainBeginV2Event>

Returns:

the associated event class for this subscription type.