Package com.github.twitch4j.eventsub.subscriptions

Class ChannelAdBreakBeginType

java.lang.Object

com.github.twitch4j.eventsub.subscriptions.ChannelAdBreakBeginType

All Implemented Interfaces:

SubscriptionType<ChannelAdBreakCondition,ChannelAdBreakCondition.ChannelAdBreakConditionBuilder<?,?>,ChannelAdBreakBeginEvent>

public class ChannelAdBreakBeginType
extends Object
implements SubscriptionType<ChannelAdBreakCondition,ChannelAdBreakCondition.ChannelAdBreakConditionBuilder<?,?>,ChannelAdBreakBeginEvent>

The channel.ad_break.begin subscription type sends a notification when a user runs a midroll commercial break, either manually or automatically via ads manager.

Must have channel:read:ads scope.

See Also:

• TwitchScopes.HELIX_CHANNEL_ADS_READ

Constructor Summary

Constructors

Constructor	Description
ChannelAdBreakBeginType()

Method Summary

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

ChannelAdBreakBeginType

public ChannelAdBreakBeginType()

Method Details

getName

public String getName()

Specified by:

getName in interface SubscriptionType<ChannelAdBreakCondition,ChannelAdBreakCondition.ChannelAdBreakConditionBuilder<?,?>,ChannelAdBreakBeginEvent>

Returns:

the subscription type name.

getVersion

public String getVersion()

Specified by:

getVersion in interface SubscriptionType<ChannelAdBreakCondition,ChannelAdBreakCondition.ChannelAdBreakConditionBuilder<?,?>,ChannelAdBreakBeginEvent>

Returns:

the subscription type version.

getConditionBuilder

public ChannelAdBreakCondition.ChannelAdBreakConditionBuilder<?,?> 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<ChannelAdBreakCondition,ChannelAdBreakCondition.ChannelAdBreakConditionBuilder<?,?>,ChannelAdBreakBeginEvent>

Returns:

Subscription-specific parameter builder.

getEventClass

public Class<ChannelAdBreakBeginEvent> getEventClass()

Specified by:

getEventClass in interface SubscriptionType<ChannelAdBreakCondition,ChannelAdBreakCondition.ChannelAdBreakConditionBuilder<?,?>,ChannelAdBreakBeginEvent>

Returns:

the associated event class for this subscription type.