Package com.github.twitch4j.eventsub.subscriptions

Class ChannelModerateType

java.lang.Object

com.github.twitch4j.eventsub.subscriptions.ChannelModerateType

All Implemented Interfaces:

SubscriptionType<ModeratorEventSubCondition,ModeratorEventSubCondition.ModeratorEventSubConditionBuilder<?,?>,ChannelModerateEvent>

public class ChannelModerateType
extends Object
implements SubscriptionType<ModeratorEventSubCondition,ModeratorEventSubCondition.ModeratorEventSubConditionBuilder<?,?>,ChannelModerateEvent>

Fires when a moderator performs a moderation action in a channel.

Must have all of the following scopes:

• moderator:read:blocked_terms OR moderator:manage:blocked_terms
• moderator:read:chat_settings OR moderator:manage:chat_settings
• moderator:read:unban_requests OR moderator:manage:unban_requests
• moderator:read:banned_users OR moderator:manage:banned_users
• moderator:read:chat_messages OR moderator:manage:chat_messages
• moderator:read:warnings OR moderator:manage:warnings
• moderator:read:moderators
• moderator:read:vips

See Also:

• TwitchScopes.HELIX_BLOCKED_TERMS_READ
• TwitchScopes.HELIX_CHAT_SETTINGS_READ
• TwitchScopes.HELIX_UNBAN_REQUESTS_READ
• TwitchScopes.HELIX_BANNED_USERS_READ
• TwitchScopes.HELIX_CHAT_MESSAGES_READ
• TwitchScopes.HELIX_MODERATORS_READ
• TwitchScopes.HELIX_VIPS_READ
• TwitchScopes.HELIX_WARNINGS_READ

Constructor Summary

Constructors

Constructor	Description
ChannelModerateType()

Method Summary

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

ChannelModerateType

public ChannelModerateType()

Method Details

getName

public String getName()

Specified by:

getName in interface SubscriptionType<ModeratorEventSubCondition,ModeratorEventSubCondition.ModeratorEventSubConditionBuilder<?,?>,ChannelModerateEvent>

Returns:

the subscription type name.

getVersion

public String getVersion()

Specified by:

getVersion in interface SubscriptionType<ModeratorEventSubCondition,ModeratorEventSubCondition.ModeratorEventSubConditionBuilder<?,?>,ChannelModerateEvent>

Returns:

the subscription type version.

getConditionBuilder

public ModeratorEventSubCondition.ModeratorEventSubConditionBuilder<?,?> 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<ModeratorEventSubCondition,ModeratorEventSubCondition.ModeratorEventSubConditionBuilder<?,?>,ChannelModerateEvent>

Returns:

Subscription-specific parameter builder.

getEventClass

public Class<ChannelModerateEvent> getEventClass()

Specified by:

getEventClass in interface SubscriptionType<ModeratorEventSubCondition,ModeratorEventSubCondition.ModeratorEventSubConditionBuilder<?,?>,ChannelModerateEvent>

Returns:

the associated event class for this subscription type.