Package com.github.twitch4j.eventsub.subscriptions

Class CharityCampaignStopType

java.lang.Object

com.github.twitch4j.eventsub.subscriptions.CharityCampaignStopType

All Implemented Interfaces:

SubscriptionType<ChannelCharityCampaignCondition,ChannelCharityCampaignCondition.ChannelCharityCampaignConditionBuilder<?,?>,CharityCampaignStopEvent>

public class CharityCampaignStopType
extends Object
implements SubscriptionType<ChannelCharityCampaignCondition,ChannelCharityCampaignCondition.ChannelCharityCampaignConditionBuilder<?,?>,CharityCampaignStopEvent>

Sends a notification when the broadcaster stops a charity campaign.

The event data does not include information about the charity such as its name, description, and logo. To get that information, subscribe to the Start event or call the Get Charity Campaign endpoint.

Requires the channel:read:charity scope.

Constructor Summary

Constructors

Constructor	Description
CharityCampaignStopType()

Method Summary

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

CharityCampaignStopType

public CharityCampaignStopType()

Method Details

getName

public String getName()

Specified by:

getName in interface SubscriptionType<ChannelCharityCampaignCondition,ChannelCharityCampaignCondition.ChannelCharityCampaignConditionBuilder<?,?>,CharityCampaignStopEvent>

Returns:

the subscription type name.

getVersion

public String getVersion()

Specified by:

getVersion in interface SubscriptionType<ChannelCharityCampaignCondition,ChannelCharityCampaignCondition.ChannelCharityCampaignConditionBuilder<?,?>,CharityCampaignStopEvent>

Returns:

the subscription type version.

getConditionBuilder

public ChannelCharityCampaignCondition.ChannelCharityCampaignConditionBuilder<?,?> 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<ChannelCharityCampaignCondition,ChannelCharityCampaignCondition.ChannelCharityCampaignConditionBuilder<?,?>,CharityCampaignStopEvent>

Returns:

Subscription-specific parameter builder.

getEventClass

public Class<CharityCampaignStopEvent> getEventClass()

Specified by:

getEventClass in interface SubscriptionType<ChannelCharityCampaignCondition,ChannelCharityCampaignCondition.ChannelCharityCampaignConditionBuilder<?,?>,CharityCampaignStopEvent>

Returns:

the associated event class for this subscription type.