Package com.github.twitch4j.eventsub.subscriptions

Class ChannelGoalProgressType

java.lang.Object

com.github.twitch4j.eventsub.subscriptions.ChannelGoalProgressType

All Implemented Interfaces:

SubscriptionType<CreatorGoalsCondition,CreatorGoalsCondition.CreatorGoalsConditionBuilder<?,?>,CreatorGoalsProgressEvent>

public class ChannelGoalProgressType
extends Object
implements SubscriptionType<CreatorGoalsCondition,CreatorGoalsCondition.CreatorGoalsConditionBuilder<?,?>,CreatorGoalsProgressEvent>

Notifies the subscriber when progress is made towards the specified broadcaster’s goal. Progress could be positive (added followers) or negative (lost followers).

NOTE: It’s possible to receive Progress events before receiving the Begin event.

Authorization: Requires a user OAuth access token with scope set to channel:read:goals.

Constructor Summary

Constructors

Constructor	Description
ChannelGoalProgressType()

Method Summary

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

ChannelGoalProgressType

public ChannelGoalProgressType()

Method Details

getName

public String getName()

Specified by:

getName in interface SubscriptionType<CreatorGoalsCondition,CreatorGoalsCondition.CreatorGoalsConditionBuilder<?,?>,CreatorGoalsProgressEvent>

Returns:

the subscription type name.

getVersion

public String getVersion()

Specified by:

getVersion in interface SubscriptionType<CreatorGoalsCondition,CreatorGoalsCondition.CreatorGoalsConditionBuilder<?,?>,CreatorGoalsProgressEvent>

Returns:

the subscription type version.

getConditionBuilder

public CreatorGoalsCondition.CreatorGoalsConditionBuilder<?,?> 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<CreatorGoalsCondition,CreatorGoalsCondition.CreatorGoalsConditionBuilder<?,?>,CreatorGoalsProgressEvent>

Returns:

Subscription-specific parameter builder.

getEventClass

public Class<CreatorGoalsProgressEvent> getEventClass()

Specified by:

getEventClass in interface SubscriptionType<CreatorGoalsCondition,CreatorGoalsCondition.CreatorGoalsConditionBuilder<?,?>,CreatorGoalsProgressEvent>

Returns:

the associated event class for this subscription type.