Package com.github.twitch4j.eventsub.subscriptions

Class DropEntitlementGrantType

java.lang.Object

com.github.twitch4j.eventsub.subscriptions.DropEntitlementGrantType

All Implemented Interfaces:

SubscriptionType<DropEntitlementGrantCondition,DropEntitlementGrantCondition.DropEntitlementGrantConditionBuilder<?,?>,BatchedDropEntitlementGrantEvents>

public class DropEntitlementGrantType
extends Object
implements SubscriptionType<DropEntitlementGrantCondition,DropEntitlementGrantCondition.DropEntitlementGrantConditionBuilder<?,?>,BatchedDropEntitlementGrantEvents>

This subscription type sends a notification when an entitlement for a Drop is granted to a user.

The client ID associated with the app access token must be owned by a user who is part of the specified organization.

Constructor Summary

Constructors

Constructor	Description
DropEntitlementGrantType()

Method Summary

Modifier and Type	Method	Description
DropEntitlementGrantCondition.DropEntitlementGrantConditionBuilder<?,?>	getConditionBuilder()	The parameters inside these objects differ by subscription type and may differ by version.
Class<BatchedDropEntitlementGrantEvents>	getEventClass()
String	getName()
String	getVersion()
boolean	isBatchingEnabled()

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

DropEntitlementGrantType

public DropEntitlementGrantType()

Method Details

getName

public String getName()

Specified by:

getName in interface SubscriptionType<DropEntitlementGrantCondition,DropEntitlementGrantCondition.DropEntitlementGrantConditionBuilder<?,?>,BatchedDropEntitlementGrantEvents>

Returns:

the subscription type name.

getVersion

public String getVersion()

Specified by:

getVersion in interface SubscriptionType<DropEntitlementGrantCondition,DropEntitlementGrantCondition.DropEntitlementGrantConditionBuilder<?,?>,BatchedDropEntitlementGrantEvents>

Returns:

the subscription type version.

getConditionBuilder

public DropEntitlementGrantCondition.DropEntitlementGrantConditionBuilder<?,?> 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<DropEntitlementGrantCondition,DropEntitlementGrantCondition.DropEntitlementGrantConditionBuilder<?,?>,BatchedDropEntitlementGrantEvents>

Returns:

Subscription-specific parameter builder.

getEventClass

public Class<BatchedDropEntitlementGrantEvents> getEventClass()

Specified by:

getEventClass in interface SubscriptionType<DropEntitlementGrantCondition,DropEntitlementGrantCondition.DropEntitlementGrantConditionBuilder<?,?>,BatchedDropEntitlementGrantEvents>

Returns:

the associated event class for this subscription type.

isBatchingEnabled

public boolean isBatchingEnabled()

Specified by:

isBatchingEnabled in interface SubscriptionType<DropEntitlementGrantCondition,DropEntitlementGrantCondition.DropEntitlementGrantConditionBuilder<?,?>,BatchedDropEntitlementGrantEvents>

Returns:

whether Twitch batches events for this subscription type.