Package com.github.twitch4j.eventsub.subscriptions

Class ConduitShardDisabledType

java.lang.Object

com.github.twitch4j.eventsub.subscriptions.ConduitShardDisabledType

All Implemented Interfaces:

SubscriptionType<ConduitCondition,ConduitCondition.ConduitConditionBuilder<?,?>,ConduitShardDisabledEvent>

public class ConduitShardDisabledType
extends Object
implements SubscriptionType<ConduitCondition,ConduitCondition.ConduitConditionBuilder<?,?>,ConduitShardDisabledEvent>

The conduit.shard.disabled subscription type sends a notification when EventSub disables a shard due to the status of the underlying transport changing.

App access token where the client ID matches the client ID in the condition. If conduit_id is specified, the client must be the owner of the conduit.

Constructor Summary

Constructors

Constructor	Description
ConduitShardDisabledType()

Method Summary

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

ConduitShardDisabledType

public ConduitShardDisabledType()

Method Details

getName

public String getName()

Specified by:

getName in interface SubscriptionType<ConduitCondition,ConduitCondition.ConduitConditionBuilder<?,?>,ConduitShardDisabledEvent>

Returns:

the subscription type name.

getVersion

public String getVersion()

Specified by:

getVersion in interface SubscriptionType<ConduitCondition,ConduitCondition.ConduitConditionBuilder<?,?>,ConduitShardDisabledEvent>

Returns:

the subscription type version.

getConditionBuilder

public ConduitCondition.ConduitConditionBuilder<?,?> 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<ConduitCondition,ConduitCondition.ConduitConditionBuilder<?,?>,ConduitShardDisabledEvent>

Returns:

Subscription-specific parameter builder.

getEventClass

public Class<ConduitShardDisabledEvent> getEventClass()

Specified by:

getEventClass in interface SubscriptionType<ConduitCondition,ConduitCondition.ConduitConditionBuilder<?,?>,ConduitShardDisabledEvent>

Returns:

the associated event class for this subscription type.