Package com.github.twitch4j.eventsub.subscriptions

Class CharityCampaignProgressType

java.lang.Object

com.github.twitch4j.eventsub.subscriptions.CharityCampaignProgressType

All Implemented Interfaces:

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

public class CharityCampaignProgressType
extends Object
implements SubscriptionType<ChannelCharityCampaignCondition,ChannelCharityCampaignCondition.ChannelCharityCampaignConditionBuilder<?,?>,CharityCampaignProgressEvent>

Sends notifications when progress is made towards the campaign’s goal or when the broadcaster changes the fundraising goal.

It’s possible to receive this event before the Start event.

The event data includes the charity’s name and logo but not its description and website. To get that information, subscribe to the Start event or call the Get Charity Campaign endpoint.

To get donation information, subscribe to the channel.charity_campaign.donate event.

Requires the channel:read:charity scope.

Constructor Summary

Constructors

Constructor	Description
CharityCampaignProgressType()

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<CharityCampaignProgressEvent>	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

CharityCampaignProgressType

public CharityCampaignProgressType()

Method Details

getName

public String getName()

Specified by:

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

Returns:

the subscription type name.

getVersion

public String getVersion()

Specified by:

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

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<?,?>,CharityCampaignProgressEvent>

Returns:

Subscription-specific parameter builder.

getEventClass

public Class<CharityCampaignProgressEvent> getEventClass()

Specified by:

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

Returns:

the associated event class for this subscription type.