Package dev.sympho.bot_utils.component

Class ModalManager

java.lang.Object

dev.sympho.bot_utils.component.ComponentManager<ModalSubmitInteractionEvent,ModalManager.ModalContext,ModalManager.HandlerFunction,ModalManager.Handler,ModalManager.HandlerEntry>

dev.sympho.bot_utils.component.ModalManager

public class ModalManager
extends ComponentManager<ModalSubmitInteractionEvent,ModalManager.ModalContext,ModalManager.HandlerFunction,ModalManager.Handler,ModalManager.HandlerEntry>

Centralized manager for modal submission handling.

Since:

1.0

Version:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ModalManager.Handler	Specification for the handling of a modal submission.
static final record	ModalManager.HandlerEntry	Specification for a handler to be registered.
static interface	ModalManager.HandlerFunction	A function used to handle a modal submit event.
final class	ModalManager.ModalContext	The execution context of a modal being submitted.

Nested classes/interfaces inherited from class dev.sympho.bot_utils.component.ComponentManager

ComponentManager.ComponentContext<E extends @NonNull ComponentInteractionEvent>

Field Summary

Fields inherited from class dev.sympho.bot_utils.component.ComponentManager

logger

Constructor Summary

Constructors

Constructor	Description
ModalManager(GatewayDiscordClient client, AccessManager accessManager)	Creates a new manager that receives interactions from the given client.

Method Summary

Modifier and Type	Method	Description
protected Class<ModalSubmitInteractionEvent>	getEventType()	Retrieves the interaction event type.
protected ModalManager.ModalContext	makeContext(ModalSubmitInteractionEvent event, AccessManager accessManager)	Creates the interaction context.
static String	makeId(String id, String args)	Creates a custom ID for a modal with arguments in a format that is compatible with this manager.
protected Mono<String>	validateInteraction(ModalManager.ModalContext context, ModalManager.Handler handler)	Validates that the interaction is allowed.

Methods inherited from class dev.sympho.bot_utils.component.ComponentManager

register, register, registerAll, start, stop, unregister

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ModalManager

@SideEffectFree
public ModalManager(GatewayDiscordClient client,
 AccessManager accessManager)

Creates a new manager that receives interactions from the given client.

Parameters:

client - The client to receive interactions from.

accessManager - The access manager to use.

Method Details

makeId

@SideEffectFree
public static String makeId(String id,
 String args)

Creates a custom ID for a modal with arguments in a format that is compatible with this manager.

Parameters:

id - The modal handler ID.

args - The interaction arguments.

Returns:

The assembled custom ID.

getEventType

protected Class<ModalSubmitInteractionEvent> getEventType()

Description copied from class: ComponentManager

Retrieves the interaction event type.

Specified by:

getEventType in class ComponentManager<ModalSubmitInteractionEvent,ModalManager.ModalContext,ModalManager.HandlerFunction,ModalManager.Handler,ModalManager.HandlerEntry>

Returns:

The interaction event type.

makeContext

protected ModalManager.ModalContext makeContext(ModalSubmitInteractionEvent event,
 AccessManager accessManager)

Description copied from class: ComponentManager

Creates the interaction context.

Specified by:

makeContext in class ComponentManager<ModalSubmitInteractionEvent,ModalManager.ModalContext,ModalManager.HandlerFunction,ModalManager.Handler,ModalManager.HandlerEntry>

Parameters:

event - The interaction event.

accessManager - The access manager.

Returns:

The created context.

validateInteraction

protected Mono<String> validateInteraction(ModalManager.ModalContext context,
 ModalManager.Handler handler)

Description copied from class: ComponentManager

Validates that the interaction is allowed.

Specified by:

validateInteraction in class ComponentManager<ModalSubmitInteractionEvent,ModalManager.ModalContext,ModalManager.HandlerFunction,ModalManager.Handler,ModalManager.HandlerEntry>

Parameters:

context - The interaction context.

handler - The invoked handler.

Returns:

A mono that completes empty if the interaction is allowed, otherwise issuing an error message to be sent to the user.