com.freya02.botcommands.api.core.GlobalExceptionHandler Maven / Gradle / Ivy
package com.freya02.botcommands.api.core;
import com.freya02.botcommands.api.BContext;
import com.freya02.botcommands.api.GlobalExceptionHandlerAdapter;
import com.freya02.botcommands.api.core.service.annotations.BService;
import com.freya02.botcommands.api.core.service.annotations.InterfacedService;
import com.freya02.botcommands.api.core.service.annotations.ServiceType;
import net.dv8tion.jda.api.events.Event;
import net.dv8tion.jda.api.interactions.Interaction;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
/**
* Interface with a method called everytime the framework catches an uncaught exception.
*
This remplaces the standard implementation which logs the error and optionally sends it to the bot owners
*
*
* Notes: You will need to handle things such as already acknowledged interactions (in the case of interaction events,
* where the exception happened after the interaction has been acknowledged), see {@link Interaction#isAcknowledged()}
*
*
* Usage: Register your instance as a service with {@link BService}, and a {@link ServiceType} of {@link GlobalExceptionHandler}.
*
*
* You are still free from extending {@link GlobalExceptionHandlerAdapter}.
*
* @see GlobalExceptionHandlerAdapter
* @see InterfacedService
*/
@InterfacedService(acceptMultiple = false)
public interface GlobalExceptionHandler {
/**
* Note: You are sent a generic Event, you will need to check it against SlashCommandInteractionEvent, GuildMessageReceivedEvent, etc... in order to differentiate events
*
* @param context The current context
* @param event The event which triggered this exception
* @param throwable The throwable which got threw
*/
void onException(@NotNull BContext context, @Nullable Event event, @NotNull Throwable throwable);
}