Package com.github.twitch4j.eventsub.subscriptions

Class ChannelSubscribeType

java.lang.Object

com.github.twitch4j.eventsub.subscriptions.ChannelSubscribeType

All Implemented Interfaces:

SubscriptionType<ChannelSubscribeCondition,ChannelSubscribeCondition.ChannelSubscribeConditionBuilder<?,?>,ChannelSubscribeEvent>

public class ChannelSubscribeType
extends Object
implements SubscriptionType<ChannelSubscribeCondition,ChannelSubscribeCondition.ChannelSubscribeConditionBuilder<?,?>,ChannelSubscribeEvent>

A notification when a specified channel receives a subscriber. This does not include resubscribes.

Must have channel:read:subscriptions scope.

Constructor Summary

Constructors

Constructor	Description
ChannelSubscribeType()

Method Summary

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

ChannelSubscribeType

public ChannelSubscribeType()

Method Details

getName

public String getName()

Specified by:

getName in interface SubscriptionType<ChannelSubscribeCondition,ChannelSubscribeCondition.ChannelSubscribeConditionBuilder<?,?>,ChannelSubscribeEvent>

Returns:

the subscription type name.

getVersion

public String getVersion()

Specified by:

getVersion in interface SubscriptionType<ChannelSubscribeCondition,ChannelSubscribeCondition.ChannelSubscribeConditionBuilder<?,?>,ChannelSubscribeEvent>

Returns:

the subscription type version.

getConditionBuilder

public ChannelSubscribeCondition.ChannelSubscribeConditionBuilder<?,?> 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<ChannelSubscribeCondition,ChannelSubscribeCondition.ChannelSubscribeConditionBuilder<?,?>,ChannelSubscribeEvent>

Returns:

Subscription-specific parameter builder.

getEventClass

public Class<ChannelSubscribeEvent> getEventClass()

Specified by:

getEventClass in interface SubscriptionType<ChannelSubscribeCondition,ChannelSubscribeCondition.ChannelSubscribeConditionBuilder<?,?>,ChannelSubscribeEvent>

Returns:

the associated event class for this subscription type.