Package com.github.twitch4j.eventsub.subscriptions

Class ChannelCheerType

java.lang.Object

com.github.twitch4j.eventsub.subscriptions.ChannelCheerType

All Implemented Interfaces:

SubscriptionType<ChannelCheerCondition,ChannelCheerCondition.ChannelCheerConditionBuilder<?,?>,ChannelCheerEvent>

public class ChannelCheerType
extends Object
implements SubscriptionType<ChannelCheerCondition,ChannelCheerCondition.ChannelCheerConditionBuilder<?,?>,ChannelCheerEvent>

A user cheers on the specified channel.

Must have bits:read scope.

Constructor Summary

Constructors

Constructor	Description
ChannelCheerType()

Method Summary

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

ChannelCheerType

public ChannelCheerType()

Method Details

getName

public String getName()

Specified by:

getName in interface SubscriptionType<ChannelCheerCondition,ChannelCheerCondition.ChannelCheerConditionBuilder<?,?>,ChannelCheerEvent>

Returns:

the subscription type name.

getVersion

public String getVersion()

Specified by:

getVersion in interface SubscriptionType<ChannelCheerCondition,ChannelCheerCondition.ChannelCheerConditionBuilder<?,?>,ChannelCheerEvent>

Returns:

the subscription type version.

getConditionBuilder

public ChannelCheerCondition.ChannelCheerConditionBuilder<?,?> 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<ChannelCheerCondition,ChannelCheerCondition.ChannelCheerConditionBuilder<?,?>,ChannelCheerEvent>

Returns:

Subscription-specific parameter builder.

getEventClass

public Class<ChannelCheerEvent> getEventClass()

Specified by:

getEventClass in interface SubscriptionType<ChannelCheerCondition,ChannelCheerCondition.ChannelCheerConditionBuilder<?,?>,ChannelCheerEvent>

Returns:

the associated event class for this subscription type.