Package com.github.twitch4j.eventsub.subscriptions

Class HypeTrainProgressType

java.lang.Object

com.github.twitch4j.eventsub.subscriptions.HypeTrainProgressType

All Implemented Interfaces:

SubscriptionType<HypeTrainProgressCondition,HypeTrainProgressCondition.HypeTrainProgressConditionBuilder<?,?>,HypeTrainProgressEvent>

public class HypeTrainProgressType
extends Object
implements SubscriptionType<HypeTrainProgressCondition,HypeTrainProgressCondition.HypeTrainProgressConditionBuilder<?,?>,HypeTrainProgressEvent>

A hype train makes progress 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 channel.hype_train.progress before you receive the corresponding channel.hype_train.begin

Constructor Summary

Constructors

Constructor	Description
HypeTrainProgressType()

Method Summary

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

HypeTrainProgressType

public HypeTrainProgressType()

Method Details

getName

public String getName()

Specified by:

getName in interface SubscriptionType<HypeTrainProgressCondition,HypeTrainProgressCondition.HypeTrainProgressConditionBuilder<?,?>,HypeTrainProgressEvent>

Returns:

the subscription type name.

getVersion

public String getVersion()

Specified by:

getVersion in interface SubscriptionType<HypeTrainProgressCondition,HypeTrainProgressCondition.HypeTrainProgressConditionBuilder<?,?>,HypeTrainProgressEvent>

Returns:

the subscription type version.

getConditionBuilder

public HypeTrainProgressCondition.HypeTrainProgressConditionBuilder<?,?> 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<HypeTrainProgressCondition,HypeTrainProgressCondition.HypeTrainProgressConditionBuilder<?,?>,HypeTrainProgressEvent>

Returns:

Subscription-specific parameter builder.

getEventClass

public Class<HypeTrainProgressEvent> getEventClass()

Specified by:

getEventClass in interface SubscriptionType<HypeTrainProgressCondition,HypeTrainProgressCondition.HypeTrainProgressConditionBuilder<?,?>,HypeTrainProgressEvent>

Returns:

the associated event class for this subscription type.