Package com.github.twitch4j.eventsub.subscriptions

Class ShoutoutReceiveType

java.lang.Object

com.github.twitch4j.eventsub.subscriptions.ShoutoutReceiveType

All Implemented Interfaces:

SubscriptionType<ChannelShoutoutCondition,ChannelShoutoutCondition.ChannelShoutoutConditionBuilder<?,?>,ShoutoutReceiveEvent>

public class ShoutoutReceiveType
extends Object
implements SubscriptionType<ChannelShoutoutCondition,ChannelShoutoutCondition.ChannelShoutoutConditionBuilder<?,?>,ShoutoutReceiveEvent>

Sends a notification when the specified broadcaster receives a Shoutout.

Note: Sent only if Twitch posts the Shoutout to the broadcaster’s activity feed.

Requires the moderator:read:shoutouts or moderator:manage:shoutouts scope.

If you use webhooks, the user in moderator_user_id must have granted your app (client ID) one of the above permissions prior to your app subscribing to this subscription type.

If you use WebSockets, the ID in moderator_user_id must match the user ID in the user access token.

See Also:

• TwitchScopes.HELIX_SHOUTOUTS_READ

Constructor Summary

Constructors

Constructor	Description
ShoutoutReceiveType()

Method Summary

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

ShoutoutReceiveType

public ShoutoutReceiveType()

Method Details

getName

public String getName()

Specified by:

getName in interface SubscriptionType<ChannelShoutoutCondition,ChannelShoutoutCondition.ChannelShoutoutConditionBuilder<?,?>,ShoutoutReceiveEvent>

Returns:

the subscription type name.

getVersion

public String getVersion()

Specified by:

getVersion in interface SubscriptionType<ChannelShoutoutCondition,ChannelShoutoutCondition.ChannelShoutoutConditionBuilder<?,?>,ShoutoutReceiveEvent>

Returns:

the subscription type version.

getConditionBuilder

public ChannelShoutoutCondition.ChannelShoutoutConditionBuilder<?,?> 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<ChannelShoutoutCondition,ChannelShoutoutCondition.ChannelShoutoutConditionBuilder<?,?>,ShoutoutReceiveEvent>

Returns:

Subscription-specific parameter builder.

getEventClass

public Class<ShoutoutReceiveEvent> getEventClass()

Specified by:

getEventClass in interface SubscriptionType<ChannelShoutoutCondition,ChannelShoutoutCondition.ChannelShoutoutConditionBuilder<?,?>,ShoutoutReceiveEvent>

Returns:

the associated event class for this subscription type.