Package com.github.twitch4j.eventsub.subscriptions

Class ShieldModeBeginType

java.lang.Object

com.github.twitch4j.eventsub.subscriptions.ShieldModeBeginType

All Implemented Interfaces:

SubscriptionType<ShieldModeCondition,ShieldModeCondition.ShieldModeConditionBuilder<?,?>,ShieldModeBeginEvent>

public class ShieldModeBeginType
extends Object
implements SubscriptionType<ShieldModeCondition,ShieldModeCondition.ShieldModeConditionBuilder<?,?>,ShieldModeBeginEvent>

Sends a notification when the broadcaster activates Shield Mode.

This event informs the subscriber that the broadcaster’s moderation settings were changed based on the broadcaster’s Shield Mode configuration settings.

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

See Also:

• TwitchScopes.HELIX_SHIELD_MODE_READ
• TwitchScopes.HELIX_SHIELD_MODE_MANAGE

Constructor Summary

Constructors

Constructor	Description
ShieldModeBeginType()

Method Summary

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

ShieldModeBeginType

public ShieldModeBeginType()

Method Details

getName

public String getName()

Specified by:

getName in interface SubscriptionType<ShieldModeCondition,ShieldModeCondition.ShieldModeConditionBuilder<?,?>,ShieldModeBeginEvent>

Returns:

the subscription type name.

getVersion

public String getVersion()

Specified by:

getVersion in interface SubscriptionType<ShieldModeCondition,ShieldModeCondition.ShieldModeConditionBuilder<?,?>,ShieldModeBeginEvent>

Returns:

the subscription type version.

getConditionBuilder

public ShieldModeCondition.ShieldModeConditionBuilder<?,?> 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<ShieldModeCondition,ShieldModeCondition.ShieldModeConditionBuilder<?,?>,ShieldModeBeginEvent>

Returns:

Subscription-specific parameter builder.

getEventClass

public Class<ShieldModeBeginEvent> getEventClass()

Specified by:

getEventClass in interface SubscriptionType<ShieldModeCondition,ShieldModeCondition.ShieldModeConditionBuilder<?,?>,ShieldModeBeginEvent>

Returns:

the associated event class for this subscription type.