Interface InteractionDefinition

All Superinterfaces:

Definition, Invokable

All Known Subinterfaces:

CommandDefinition, ComponentDefinition<T>, SelectMenuDefinition<T>

All Known Implementing Classes:

AutoCompleteDefinition, ButtonDefinition, ContextCommandDefinition, EntitySelectMenuDefinition, ModalDefinition, SlashCommandDefinition, StringSelectMenuDefinition

public sealed interface InteractionDefinition
extends Definition, Invokable
permits AutoCompleteDefinition, ModalDefinition, CommandDefinition, ComponentDefinition<T>

Common interface for all definitions that represent an interaction.

See Also:

• AutoCompleteDefinition
• ModalDefinition
• ContextCommandDefinition
• SlashCommandDefinition
• ButtonDefinition
• EntitySelectMenuDefinition
• StringSelectMenuDefinition

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	InteractionDefinition.ReplyConfig	Stores the configuration values for sending replies.

Field Summary

Fields inherited from interface Invokable

log

Method Summary

Modifier and Type	Method	Description
static String	createDefinitionId(String className, String methodName)	Creates a definition id from the classname and method name
default String	definitionId()	The id for this definition.
Collection<String>	permissions()	A possibly-empty Collection of permissions for this interaction.

Methods inherited from interface Definition

displayName

Methods inherited from interface Invokable

classDescription, invoke, methodDescription

Method Details

createDefinitionId

static String createDefinitionId(String className,
 String methodName)

Creates a definition id from the classname and method name

Parameters:

className - the classname (Class.getName() or ClassDescription.name())

methodName - the method name (Method.getName() or MethodDescription.name())

Returns:

the definition id

definitionId

default String definitionId()

The id for this definition. For interaction definition this is the hash code of the full class name and method name combined.

Specified by:

definitionId in interface Definition

permissions

Collection<String> permissions()

A possibly-empty Collection of permissions for this interaction.

API Note:

The PermissionsMiddleware will validate the provided permissions.