BotCommands/io.github.freya022.botcommands.api.core.annotations/BEventListener

BEventListener

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class BEventListener(val async: Boolean = false, val mode: BEventListener.RunMode = RunMode.SHARED, val priority: Int = 0, val ignoreIntents: Boolean = false, val ignoredIntents: Array<GatewayIntent> = [], val timeout: Long = 0, val timeoutUnit: TimeUnit = TimeUnit.SECONDS)(source)

Annotates a function as an event listener for a JDA or BC event.

Remember to always check the requirements of the events you're listening to!

Requirements

The declaring class must be a service
The function must not be static
The first argument must be a subclass of GenericEvent or BGenericEvent

Types

enum RunMode : Enum<BEventListener.RunMode>

Represents how the event listener will run

Properties

val ~~async~~: Boolean = false

Whether this event listener is executed on its own coroutine, using the event dispatcher scope

val ignoredIntents: Array<GatewayIntent>

Intents which should not be required for this event listener.

val ignoreIntents: Boolean = false

Whether this event listener should be kept enabled, even if it is missing intents.

val mode: BEventListener.RunMode

How this event listener should run, see RunMode values.

val priority: Int = 0

The priority for this event listener

val timeout: Long = 0

The time before the coroutine is canceled, using a negative value means no timeout.

val timeoutUnit: TimeUnit

The time unit used for the timeout