Package com.github.twitch4j.eventsub.subscriptions

Class BetaChannelSubscriptionGiftType

java.lang.Object

com.github.twitch4j.eventsub.subscriptions.BetaChannelSubscriptionGiftType

All Implemented Interfaces:

SubscriptionType<ChannelSubscriptionGiftCondition,ChannelSubscriptionGiftCondition.ChannelSubscriptionGiftConditionBuilder<?,?>,ChannelSubscriptionGiftEvent>

@Unofficial
public class BetaChannelSubscriptionGiftType
extends java.lang.Object
implements SubscriptionType<ChannelSubscriptionGiftCondition,ChannelSubscriptionGiftCondition.ChannelSubscriptionGiftConditionBuilder<?,?>,ChannelSubscriptionGiftEvent>

The channel.subscription.gift subscription type sends a notification when a user gives one or more gifted subscriptions in a channel.

Must have channel:read:subscriptions scope.

Unless otherwise noted, EventSub subscriptions that were released as a public beta will be available for 30 days after their v1 version is released. Subscriptions should be updated to v1 during this timeframe. Any active beta subscriptions beyond 30 days will be automatically deleted.

Constructor Summary

Constructors

Constructor	Description
BetaChannelSubscriptionGiftType()

Method Summary

Modifier and Type	Method	Description
ChannelSubscriptionGiftCondition.ChannelSubscriptionGiftConditionBuilder<?,?>	getConditionBuilder()	The parameters inside these objects differ by subscription type and may differ by version.
java.lang.Class<ChannelSubscriptionGiftEvent>	getEventClass()
java.lang.String	getName()
java.lang.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, prepareSubscription

Constructor Details

BetaChannelSubscriptionGiftType

public BetaChannelSubscriptionGiftType()

Method Details

getName

public java.lang.String getName()

Specified by:

getName in interface SubscriptionType<ChannelSubscriptionGiftCondition,ChannelSubscriptionGiftCondition.ChannelSubscriptionGiftConditionBuilder<?,?>,ChannelSubscriptionGiftEvent>

Returns:

the subscription type name.

getVersion

public java.lang.String getVersion()

Specified by:

getVersion in interface SubscriptionType<ChannelSubscriptionGiftCondition,ChannelSubscriptionGiftCondition.ChannelSubscriptionGiftConditionBuilder<?,?>,ChannelSubscriptionGiftEvent>

Returns:

the subscription type version.

getConditionBuilder

public ChannelSubscriptionGiftCondition.ChannelSubscriptionGiftConditionBuilder<?,?> 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<ChannelSubscriptionGiftCondition,ChannelSubscriptionGiftCondition.ChannelSubscriptionGiftConditionBuilder<?,?>,ChannelSubscriptionGiftEvent>

Returns:

Subscription-specific parameter builder.

getEventClass

public java.lang.Class<ChannelSubscriptionGiftEvent> getEventClass()

Specified by:

getEventClass in interface SubscriptionType<ChannelSubscriptionGiftCondition,ChannelSubscriptionGiftCondition.ChannelSubscriptionGiftConditionBuilder<?,?>,ChannelSubscriptionGiftEvent>

Returns:

the associated event class for this subscription type.