Package com.github.twitch4j.eventsub.subscriptions

Class ChannelClearUserMessagesType

java.lang.Object

com.github.twitch4j.eventsub.subscriptions.ChannelClearUserMessagesType

All Implemented Interfaces:

SubscriptionType<ChannelChatCondition,ChannelChatCondition.ChannelChatConditionBuilder<?,?>,ChannelChatClearUserMessagesEvent>

public class ChannelClearUserMessagesType
extends Object
implements SubscriptionType<ChannelChatCondition,ChannelChatCondition.ChannelChatConditionBuilder<?,?>,ChannelChatClearUserMessagesEvent>

Sends a notification when a moderator or bot clears all messages for a specific user, which occurs when the user has been timed out or banned.

Requires user:read:chat scope from chatting user. If app access token used, then additionally requires user:bot scope from chatting user, and either channel:bot scope from broadcaster or moderator status.

See Also:

• TwitchScopes.CHAT_USER_READ
• TwitchScopes.CHAT_USER_BOT
• TwitchScopes.CHAT_CHANNEL_BOT

Constructor Summary

Constructors

Constructor	Description
ChannelClearUserMessagesType()

Method Summary

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

ChannelClearUserMessagesType

public ChannelClearUserMessagesType()

Method Details

getName

public String getName()

Specified by:

getName in interface SubscriptionType<ChannelChatCondition,ChannelChatCondition.ChannelChatConditionBuilder<?,?>,ChannelChatClearUserMessagesEvent>

Returns:

the subscription type name.

getVersion

public String getVersion()

Specified by:

getVersion in interface SubscriptionType<ChannelChatCondition,ChannelChatCondition.ChannelChatConditionBuilder<?,?>,ChannelChatClearUserMessagesEvent>

Returns:

the subscription type version.

getConditionBuilder

public ChannelChatCondition.ChannelChatConditionBuilder<?,?> 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<ChannelChatCondition,ChannelChatCondition.ChannelChatConditionBuilder<?,?>,ChannelChatClearUserMessagesEvent>

Returns:

Subscription-specific parameter builder.

getEventClass

public Class<ChannelChatClearUserMessagesEvent> getEventClass()

Specified by:

getEventClass in interface SubscriptionType<ChannelChatCondition,ChannelChatCondition.ChannelChatConditionBuilder<?,?>,ChannelChatClearUserMessagesEvent>

Returns:

the associated event class for this subscription type.