Class ShoutoutCreateType
java.lang.Object
com.github.twitch4j.eventsub.subscriptions.ShoutoutCreateType
- All Implemented Interfaces:
SubscriptionType<ChannelShoutoutCondition,
ChannelShoutoutCondition.ChannelShoutoutConditionBuilder<?, ?>, ShoutoutCreateEvent>
public class ShoutoutCreateType
extends Object
implements SubscriptionType<ChannelShoutoutCondition,ChannelShoutoutCondition.ChannelShoutoutConditionBuilder<?,?>,ShoutoutCreateEvent>
Sends a notification when the specified broadcaster sends a Shoutout.
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:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionThe parameters inside these objects differ by subscription type and may differ by version.getName()
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
-
ShoutoutCreateType
public ShoutoutCreateType()
-
-
Method Details
-
getName
- Specified by:
getName
in interfaceSubscriptionType<ChannelShoutoutCondition,
ChannelShoutoutCondition.ChannelShoutoutConditionBuilder<?, ?>, ShoutoutCreateEvent> - Returns:
- the subscription type name.
-
getVersion
- Specified by:
getVersion
in interfaceSubscriptionType<ChannelShoutoutCondition,
ChannelShoutoutCondition.ChannelShoutoutConditionBuilder<?, ?>, ShoutoutCreateEvent> - Returns:
- the subscription type version.
-
getConditionBuilder
Description copied from interface:SubscriptionType
The parameters inside these objects differ by subscription type and may differ by version.- Specified by:
getConditionBuilder
in interfaceSubscriptionType<ChannelShoutoutCondition,
ChannelShoutoutCondition.ChannelShoutoutConditionBuilder<?, ?>, ShoutoutCreateEvent> - Returns:
- Subscription-specific parameter builder.
-
getEventClass
- Specified by:
getEventClass
in interfaceSubscriptionType<ChannelShoutoutCondition,
ChannelShoutoutCondition.ChannelShoutoutConditionBuilder<?, ?>, ShoutoutCreateEvent> - Returns:
- the associated event class for this subscription type.
-