Package xyz.dynxsty.dih4jda.events

Interface DIH4JDAEventListener

public interface DIH4JDAEventListener

An interface containing all events and their method that DIH4JDA can fire.

Method Summary

Modifier and Type	Method	Description
default void	onAutoCompleteException(AutoCompleteExceptionEvent event)	An event that gets fired when an exception gets raised while handling an autocomplete interaction.
default void	onCommandCooldown(CommandCooldownEvent event)	An event that gets fired when the user, which invoked the command, is not yet able to use this command due to a specified Command Cooldown Command Cooldowns DO NOT persist between sessions!
default void	onCommandException(CommandExceptionEvent event)	An event that gets fired when an exception gets raised while executing any command.
default void	onComponentException(ComponentExceptionEvent event)	An event that gets fired when an exception gets raised while interacting with a message component.
default void	onInsufficientPermissions(InsufficientPermissionsEvent event)	An event that gets fired when the user, which invoked the command, does NOT have one of the required permissions.
default void	onInvalidGuild(InvalidGuildEvent event)	An event that gets fired when the command is NOT executed in one of the required guild.
default void	onInvalidRole(InvalidRoleEvent event)	An event that gets fired when the user, which invoked the command, does NOT have the required roles to use this command.
default void	onInvalidUser(InvalidUserEvent event)	An event that gets fired when the user, which invoked the command, is NOT allowed to use this command.
default void	onModalException(ModalExceptionEvent event)	An event that gets fired when an exception gets raised while handling a modal interaction.

Method Details

onCommandException

default void onCommandException(@Nonnull
 CommandExceptionEvent event)

An event that gets fired when an exception gets raised while executing any command.

Parameters:

event - The CommandExceptionEvent that was fired.

See Also:

• SlashCommand.execute(SlashCommandInteractionEvent)
• SlashCommand.execute(SlashCommandInteractionEvent)
• ExecutableCommand.execute(Object)
• ExecutableCommand.execute(Object)

onComponentException

default void onComponentException(@Nonnull
 ComponentExceptionEvent event)

An event that gets fired when an exception gets raised while interacting with a message component.

Parameters:

event - The ComponentExceptionEvent that was fired.

onAutoCompleteException

default void onAutoCompleteException(@Nonnull
 AutoCompleteExceptionEvent event)

An event that gets fired when an exception gets raised while handling an autocomplete interaction.

Parameters:

event - The AutoCompleteExceptionEvent that was fired.

See Also:

• AutoCompletable.handleAutoComplete(CommandAutoCompleteInteractionEvent, AutoCompleteQuery)

onModalException

default void onModalException(@Nonnull
 ModalExceptionEvent event)

An event that gets fired when an exception gets raised while handling a modal interaction.

Parameters:

event - The ModalExceptionEvent that was fired.

onInsufficientPermissions

default void onInsufficientPermissions(@Nonnull
 InsufficientPermissionsEvent event)

An event that gets fired when the user, which invoked the command, does NOT have one of the required permissions.

Parameters:

event - The InsufficientPermissionsEvent that was fired.

See Also:

• RestrictedCommand.setRequiredPermissions(Permission...)

onInvalidUser

default void onInvalidUser(@Nonnull
 InvalidUserEvent event)

An event that gets fired when the user, which invoked the command, is NOT allowed to use this command.

Parameters:

event - The InvalidUserEvent that was fired.

See Also:

• RestrictedCommand.setRequiredUsers(Long...)

onInvalidRole

default void onInvalidRole(@Nonnull
 InvalidRoleEvent event)

An event that gets fired when the user, which invoked the command, does NOT have the required roles to use this command.

Parameters:

event - The InvalidRoleEvent that was fired.

See Also:

• RestrictedCommand.setRequiredRoles(Long...)

onInvalidGuild

default void onInvalidGuild(@Nonnull
 InvalidGuildEvent event)

An event that gets fired when the command is NOT executed in one of the required guild.

Parameters:

event - the provided InvalidGuildEvent instance.

See Also:

• RestrictedCommand.setRequiredGuilds(Long...)

onCommandCooldown

default void onCommandCooldown(@Nonnull
 CommandCooldownEvent event)

An event that gets fired when the user, which invoked the command, is not yet able to use this command due to a specified Command Cooldown
Command Cooldowns DO NOT persist between sessions!

Parameters:

event - The CommandCooldownEvent that was fired.

See Also:

• RestrictedCommand.setCommandCooldown(Duration)