Package dev.sympho.bot_utils.component

Class ButtonManager

java.lang.Object

dev.sympho.bot_utils.component.ComponentManager<ButtonInteractionEvent,ButtonEventContext,ButtonManager.HandlerFunction,ButtonManager.Handler>

dev.sympho.bot_utils.component.ButtonManager

@Enclosing
public class ButtonManager
extends ComponentManager<ButtonInteractionEvent,ButtonEventContext,ButtonManager.HandlerFunction,ButtonManager.Handler>

Centralized manager for button interaction handling.

Since:

1.0

Version:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ButtonManager.Handler	Specification for the handling of a button.
static interface	ButtonManager.HandlerFunction	A function used to handle a button press event.

Field Summary

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

logger

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected Class<ButtonInteractionEvent>	getEventType()	Retrieves the interaction event type.
protected ButtonEventContext	makeContext(ButtonInteractionEvent event, AccessManager accessManager)	Creates the interaction context.
static String	makeId(String id, String args)	Creates a custom ID for a button with arguments in a format that is compatible with this manager.
protected Mono<?>	runHandler(ButtonManager.Handler handler, ButtonEventContext context, String args)	Executes the selected handler.

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

register, registerAll, reportFailure, sourceField, start, stop, unregister

Methods inherited from class java.lang.Object

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

Constructor Details

ButtonManager

@SideEffectFree
public ButtonManager(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 button with arguments in a format that is compatible with this manager.

Parameters:

id - The button handler ID.

args - The interaction arguments.

Returns:

The assembled custom ID.

getEventType

protected Class<ButtonInteractionEvent> getEventType()

Description copied from class: ComponentManager

Retrieves the interaction event type.

Specified by:

getEventType in class ComponentManager<ButtonInteractionEvent,ButtonEventContext,ButtonManager.HandlerFunction,ButtonManager.Handler>

Returns:

The interaction event type.

makeContext

protected ButtonEventContext makeContext(ButtonInteractionEvent event,
 AccessManager accessManager)

Description copied from class: ComponentManager

Creates the interaction context.

Specified by:

makeContext in class ComponentManager<ButtonInteractionEvent,ButtonEventContext,ButtonManager.HandlerFunction,ButtonManager.Handler>

Parameters:

event - The interaction event.

accessManager - The access manager.

Returns:

The created context.

runHandler

protected Mono<?> runHandler(ButtonManager.Handler handler,
 ButtonEventContext context,
 String args)

Description copied from class: ComponentManager

Executes the selected handler.

Overrides:

runHandler in class ComponentManager<ButtonInteractionEvent,ButtonEventContext,ButtonManager.HandlerFunction,ButtonManager.Handler>

Parameters:

handler - The handler to execute.

context - The execution context.

args - The execution arguments.

Returns:

A mono that completes when handling is complete. It may result in an AccessException to indicate that the user does not have sufficient permissions.