Package com.github.twitch4j.eventsub.subscriptions

Class PollProgressType

java.lang.Object

com.github.twitch4j.eventsub.subscriptions.PollProgressType

All Implemented Interfaces:

SubscriptionType<ChannelPollProgressCondition,ChannelPollProgressCondition.ChannelPollProgressConditionBuilder<?,?>,ChannelPollProgressEvent>

public class PollProgressType
extends Object
implements SubscriptionType<ChannelPollProgressCondition,ChannelPollProgressCondition.ChannelPollProgressConditionBuilder<?,?>,ChannelPollProgressEvent>

The channel.poll.progress subscription type sends a notification when users respond to a poll on the specified channel.

Must have the channel:read:polls or channel:manage:polls scope.

Constructor Summary

Constructors

Constructor	Description
PollProgressType()

Method Summary

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

PollProgressType

public PollProgressType()

Method Details

getName

public String getName()

Specified by:

getName in interface SubscriptionType<ChannelPollProgressCondition,ChannelPollProgressCondition.ChannelPollProgressConditionBuilder<?,?>,ChannelPollProgressEvent>

Returns:

the subscription type name.

getVersion

public String getVersion()

Specified by:

getVersion in interface SubscriptionType<ChannelPollProgressCondition,ChannelPollProgressCondition.ChannelPollProgressConditionBuilder<?,?>,ChannelPollProgressEvent>

Returns:

the subscription type version.

getConditionBuilder

public ChannelPollProgressCondition.ChannelPollProgressConditionBuilder<?,?> 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<ChannelPollProgressCondition,ChannelPollProgressCondition.ChannelPollProgressConditionBuilder<?,?>,ChannelPollProgressEvent>

Returns:

Subscription-specific parameter builder.

getEventClass

public Class<ChannelPollProgressEvent> getEventClass()

Specified by:

getEventClass in interface SubscriptionType<ChannelPollProgressCondition,ChannelPollProgressCondition.ChannelPollProgressConditionBuilder<?,?>,ChannelPollProgressEvent>

Returns:

the associated event class for this subscription type.