Package com.github.twitch4j.eventsub.subscriptions

Class UnbanRequestCreateType

java.lang.Object

com.github.twitch4j.eventsub.subscriptions.UnbanRequestCreateType

All Implemented Interfaces:

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

public class UnbanRequestCreateType
extends Object
implements SubscriptionType<ModeratorEventSubCondition,ModeratorEventSubCondition.ModeratorEventSubConditionBuilder<?,?>,UnbanRequestCreatedEvent>

Fires when a user creates an unban request.

Must have moderator:read:unban_requests or moderator:manage:unban_requests scope.

If you use webhooks, the user in moderator_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_id must match the user ID in the user access token.

See Also:

• TwitchScopes.HELIX_UNBAN_REQUESTS_MANAGE
• TwitchScopes.HELIX_UNBAN_REQUESTS_READ

Constructor Summary

Constructors

Constructor	Description
UnbanRequestCreateType()

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<UnbanRequestCreatedEvent>	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

UnbanRequestCreateType

public UnbanRequestCreateType()

Method Details

getName

public String getName()

Specified by:

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

Returns:

the subscription type name.

getVersion

public String getVersion()

Specified by:

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

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<?,?>,UnbanRequestCreatedEvent>

Returns:

Subscription-specific parameter builder.

getEventClass

public Class<UnbanRequestCreatedEvent> getEventClass()

Specified by:

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

Returns:

the associated event class for this subscription type.