Package com.github.twitch4j.eventsub.subscriptions

Class PollBeginType

java.lang.Object

com.github.twitch4j.eventsub.subscriptions.PollBeginType

All Implemented Interfaces:

SubscriptionType<ChannelPollBeginCondition,ChannelPollBeginCondition.ChannelPollBeginConditionBuilder<?,?>,ChannelPollBeginEvent>

public class PollBeginType
extends Object
implements SubscriptionType<ChannelPollBeginCondition,ChannelPollBeginCondition.ChannelPollBeginConditionBuilder<?,?>,ChannelPollBeginEvent>

The channel.poll.begin subscription type sends a notification when a poll begins on the specified channel.

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

Constructor Summary

Constructors

Constructor	Description
PollBeginType()

Method Summary

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

PollBeginType

public PollBeginType()

Method Details

getName

public String getName()

Specified by:

getName in interface SubscriptionType<ChannelPollBeginCondition,ChannelPollBeginCondition.ChannelPollBeginConditionBuilder<?,?>,ChannelPollBeginEvent>

Returns:

the subscription type name.

getVersion

public String getVersion()

Specified by:

getVersion in interface SubscriptionType<ChannelPollBeginCondition,ChannelPollBeginCondition.ChannelPollBeginConditionBuilder<?,?>,ChannelPollBeginEvent>

Returns:

the subscription type version.

getConditionBuilder

public ChannelPollBeginCondition.ChannelPollBeginConditionBuilder<?,?> 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<ChannelPollBeginCondition,ChannelPollBeginCondition.ChannelPollBeginConditionBuilder<?,?>,ChannelPollBeginEvent>

Returns:

Subscription-specific parameter builder.

getEventClass

public Class<ChannelPollBeginEvent> getEventClass()

Specified by:

getEventClass in interface SubscriptionType<ChannelPollBeginCondition,ChannelPollBeginCondition.ChannelPollBeginConditionBuilder<?,?>,ChannelPollBeginEvent>

Returns:

the associated event class for this subscription type.