Package com.github.twitch4j.eventsub.subscriptions

Class WhisperReceivedType

java.lang.Object

com.github.twitch4j.eventsub.subscriptions.WhisperReceivedType

All Implemented Interfaces:

SubscriptionType<UserEventSubCondition,UserEventSubCondition.UserEventSubConditionBuilder<?,?>,WhisperReceivedEvent>

public class WhisperReceivedType
extends Object
implements SubscriptionType<UserEventSubCondition,UserEventSubCondition.UserEventSubConditionBuilder<?,?>,WhisperReceivedEvent>

Fires when anyone whispers the specified user.

Must have oauth scope user:read:whispers or user:manage:whispers.

See Also:

• TwitchScopes.HELIX_USER_WHISPERS_READ
• TwitchScopes.HELIX_USER_WHISPERS_MANAGE

Constructor Summary

Constructors

Constructor	Description
WhisperReceivedType()

Method Summary

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

WhisperReceivedType

public WhisperReceivedType()

Method Details

getName

public String getName()

Specified by:

getName in interface SubscriptionType<UserEventSubCondition,UserEventSubCondition.UserEventSubConditionBuilder<?,?>,WhisperReceivedEvent>

Returns:

the subscription type name.

getVersion

public String getVersion()

Specified by:

getVersion in interface SubscriptionType<UserEventSubCondition,UserEventSubCondition.UserEventSubConditionBuilder<?,?>,WhisperReceivedEvent>

Returns:

the subscription type version.

getConditionBuilder

public UserEventSubCondition.UserEventSubConditionBuilder<?,?> 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<UserEventSubCondition,UserEventSubCondition.UserEventSubConditionBuilder<?,?>,WhisperReceivedEvent>

Returns:

Subscription-specific parameter builder.

getEventClass

public Class<WhisperReceivedEvent> getEventClass()

Specified by:

getEventClass in interface SubscriptionType<UserEventSubCondition,UserEventSubCondition.UserEventSubConditionBuilder<?,?>,WhisperReceivedEvent>

Returns:

the associated event class for this subscription type.