Package com.github.twitch4j.eventsub.subscriptions

Class HypeTrainProgressV2Type

java.lang.Object

com.github.twitch4j.eventsub.subscriptions.HypeTrainProgressV2Type

All Implemented Interfaces:

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

public class HypeTrainProgressV2Type
extends Object
implements SubscriptionType<ChannelEventSubCondition,ChannelEventSubCondition.ChannelEventSubConditionBuilder<?,?>,HypeTrainProgressV2Event>

The channel.hype_train.progress subscription type sends a notification when a Hype Train makes progress on the specified channel. channel.hype_train.progress notifications are sent periodically while a Hype Train is making progress. EventSub does not make strong assurances about the order of message delivery, so it is possible to receive channel.hype_train.progress before you receive the corresponding channel.hype_train.begin.

When the Hype Train is over, channel.hype_train.end is emitted.

Authorization: Must have channel:read:hype_train scope.

Constructor Summary

Constructors

Constructor	Description
HypeTrainProgressV2Type()

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<HypeTrainProgressV2Event>	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

HypeTrainProgressV2Type

public HypeTrainProgressV2Type()

Method Details

getName

public String getName()

Specified by:

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

Returns:

the subscription type name.

getVersion

public String getVersion()

Specified by:

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

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<?,?>,HypeTrainProgressV2Event>

Returns:

Subscription-specific parameter builder.

getEventClass

public Class<HypeTrainProgressV2Event> getEventClass()

Specified by:

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

Returns:

the associated event class for this subscription type.