Interface InteractionDefinition

All Superinterfaces:

Definition, com.github.kaktushose.jda.commands.definitions.features.internal.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, com.github.kaktushose.jda.commands.definitions.features.internal.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 com.github.kaktushose.jda.commands.definitions.features.internal.Invokable

log

Method Summary

Modifier and Type	Method	Description
default @NotNull String	definitionId()	The id for this definition.
default Object	newInstance()	Creates a new instance of the Interaction class.
@NotNull Collection<String>	permissions()	A possibly-empty Collection of permissions for this interaction.
default @NotNull InteractionDefinition.ReplyConfig	replyConfig(@NotNull InteractionDefinition.ReplyConfig globalFallback)	The InteractionDefinition.ReplyConfig that should be used when sending replies.

Methods inherited from interface com.github.kaktushose.jda.commands.definitions.Definition

displayName

Methods inherited from interface com.github.kaktushose.jda.commands.definitions.features.internal.Invokable

clazzDescription, invoke, methodDescription

Method Details

definitionId

@NotNull
default @NotNull 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

newInstance

@Internal
default Object newInstance()
                    throws InvocationTargetException,
InstantiationException,
IllegalAccessException

Creates a new instance of the Interaction class.

Returns:

a new instance of the declaring class of the method this definition is bound to.

Throws:

InvocationTargetException - if the object creation fails

InstantiationException - if the object creation fails

IllegalAccessException - if the object creation fails

permissions

@NotNull
@NotNull Collection<String> permissions()

A possibly-empty Collection of permissions for this interaction.

API Note:

The PermissionsMiddleware will validate the provided permissions.

replyConfig

@NotNull
default @NotNull InteractionDefinition.ReplyConfig replyConfig(@NotNull
 @NotNull InteractionDefinition.ReplyConfig globalFallback)

The InteractionDefinition.ReplyConfig that should be used when sending replies.

Implementation Note:

This will first attempt to use the ReplyConfig annotation of the method and then of the class. If neither is present will fall back to the global InteractionDefinition.ReplyConfig provided by JDACommandsBuilder