Package com.github.twitch4j.eventsub.subscriptions

Class BetaChannelFollowType

java.lang.Object

com.github.twitch4j.eventsub.subscriptions.BetaChannelFollowType

All Implemented Interfaces:

SubscriptionType<ChannelFollowV2Condition,ChannelFollowV2Condition.ChannelFollowV2ConditionBuilder<?,?>,ChannelFollowEvent>

@Experimental
public class BetaChannelFollowType
extends Object
implements SubscriptionType<ChannelFollowV2Condition,ChannelFollowV2Condition.ChannelFollowV2ConditionBuilder<?,?>,ChannelFollowEvent>

A specified channel receives a follow.

Must have TwitchScopes.HELIX_CHANNEL_FOLLOWERS_READ scope; the broadcaster or a moderator must have authenticated with your client_id for this scope.

Warning: you will not be able to create subscriptions with this type after 2023-02-17 (but existing subscriptions will work for a few weeks afterwards) in favor of ChannelFollowTypeV2.

See Also:

• Official Announcement

Constructor Summary

Constructors

Constructor	Description
BetaChannelFollowType()

Method Summary

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

BetaChannelFollowType

public BetaChannelFollowType()

Method Details

getName

public String getName()

Specified by:

getName in interface SubscriptionType<ChannelFollowV2Condition,ChannelFollowV2Condition.ChannelFollowV2ConditionBuilder<?,?>,ChannelFollowEvent>

Returns:

the subscription type name.

getVersion

public String getVersion()

Specified by:

getVersion in interface SubscriptionType<ChannelFollowV2Condition,ChannelFollowV2Condition.ChannelFollowV2ConditionBuilder<?,?>,ChannelFollowEvent>

Returns:

the subscription type version.

getConditionBuilder

public ChannelFollowV2Condition.ChannelFollowV2ConditionBuilder<?,?> 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<ChannelFollowV2Condition,ChannelFollowV2Condition.ChannelFollowV2ConditionBuilder<?,?>,ChannelFollowEvent>

Returns:

Subscription-specific parameter builder.

getEventClass

public Class<ChannelFollowEvent> getEventClass()

Specified by:

getEventClass in interface SubscriptionType<ChannelFollowV2Condition,ChannelFollowV2Condition.ChannelFollowV2ConditionBuilder<?,?>,ChannelFollowEvent>

Returns:

the associated event class for this subscription type.