kord-extensions/dev.kordex.core.extensions

Package-level declarations

Types

Link copied to clipboard
abstract class Extension : KordExKoinComponent

Class representing a distinct set of functionality to be treated as a unit.

Link copied to clipboard
enum ExtensionState : Enum<ExtensionState>

Extension states, which describe what state of loading/unloading an extension is currently in.

Functions

Link copied to clipboard
fun <T : Arguments> Extension.chatCommand(commandObj: ChatCommand<T>): ChatCommand<T>

Function for registering a custom command object.

suspend fun Extension.chatCommand(body: suspend ChatCommand<Arguments>.() -> Unit): ChatCommand<Arguments>

DSL function for easily registering a command, without arguments.

suspend fun <T : Arguments> Extension.chatCommand(arguments: () -> T, body: suspend ChatCommand<T>.() -> Unit): ChatCommand<T>

DSL function for easily registering a command.

Link copied to clipboard
fun Extension.chatCommandCheck(vararg checks: ChatCommandCheck)

Define a check which must pass for the command to be executed. This check will be applied to all commands in this extension.

fun Extension.chatCommandCheck(check: ChatCommandCheck)

Overloaded check function to allow for DSL syntax.

Link copied to clipboard
suspend fun Extension.chatGroupCommand(body: suspend ChatGroupCommand<Arguments>.() -> Unit): ChatGroupCommand<Arguments>

DSL function for easily registering a grouped command, without its own arguments.

suspend fun <T : Arguments> Extension.chatGroupCommand(arguments: () -> T, body: suspend ChatGroupCommand<T>.() -> Unit): ChatGroupCommand<T>

DSL function for easily registering a grouped command.

Link copied to clipboard
suspend fun <M : ModalForm> Extension.ephemeralMessageCommand(commandObj: EphemeralMessageCommand<M>): EphemeralMessageCommand<M>

Register a custom instance of an ephemeral message command.

suspend fun Extension.ephemeralMessageCommand(body: suspend EphemeralMessageCommand<ModalForm>.() -> Unit): EphemeralMessageCommand<ModalForm>
suspend fun <M : ModalForm> Extension.ephemeralMessageCommand(modal: () -> M, body: suspend EphemeralMessageCommand<M>.() -> Unit): EphemeralMessageCommand<M>

Register an ephemeral message command, DSL-style.

Link copied to clipboard
suspend fun <T : Arguments, M : ModalForm> Extension.ephemeralSlashCommand(commandObj: EphemeralSlashCommand<T, M>): EphemeralSlashCommand<T, M>

Function for registering a custom ephemeral slash command object.

suspend fun Extension.ephemeralSlashCommand(body: suspend EphemeralSlashCommand<Arguments, ModalForm>.() -> Unit): EphemeralSlashCommand<Arguments, ModalForm>

DSL function for easily registering an ephemeral slash command, without arguments.

suspend fun <T : Arguments> Extension.ephemeralSlashCommand(arguments: () -> T, body: suspend EphemeralSlashCommand<T, ModalForm>.() -> Unit): EphemeralSlashCommand<T, ModalForm>

DSL function for easily registering an ephemeral slash command, with arguments.

@JvmName(name = "ephemeralSlashCommand1")
suspend fun <M : ModalForm> Extension.ephemeralSlashCommand(modal: () -> M, body: suspend EphemeralSlashCommand<Arguments, M>.() -> Unit): EphemeralSlashCommand<Arguments, M>
suspend fun <A : Arguments, M : ModalForm> Extension.ephemeralSlashCommand(arguments: () -> A, modal: () -> M, body: suspend EphemeralSlashCommand<A, M>.() -> Unit): EphemeralSlashCommand<A, M>

DSL function for easily registering an ephemeral slash command, with a modal form.

Link copied to clipboard
suspend fun <M : ModalForm> Extension.ephemeralUserCommand(commandObj: EphemeralUserCommand<M>): EphemeralUserCommand<M>

Register a custom instance of an ephemeral user command.

suspend fun Extension.ephemeralUserCommand(body: suspend EphemeralUserCommand<ModalForm>.() -> Unit): EphemeralUserCommand<ModalForm>
suspend fun <M : ModalForm> Extension.ephemeralUserCommand(modal: () -> M, body: suspend EphemeralUserCommand<M>.() -> Unit): EphemeralUserCommand<M>

Register an ephemeral user command, DSL-style.

Link copied to clipboard
inline suspend fun <T : Event> Extension.event(noinline constructor: (Extension) -> EventHandler<T> = ::EventHandler, noinline body: suspend EventHandler<T>.() -> Unit): EventHandler<T>

DSL function for easily registering an event handler.

Link copied to clipboard
fun Extension.messageCommandCheck(vararg checks: MessageCommandCheck)

Define a check which must pass for a message command to be executed. This check will be applied to all message commands in this extension.

fun Extension.messageCommandCheck(check: MessageCommandCheck)

Overloaded message command check function to allow for DSL syntax.

Link copied to clipboard
suspend fun <M : ModalForm> Extension.publicMessageCommand(commandObj: PublicMessageCommand<M>): PublicMessageCommand<M>

Register a custom instance of a public message command.

suspend fun Extension.publicMessageCommand(body: suspend PublicMessageCommand<ModalForm>.() -> Unit): PublicMessageCommand<ModalForm>
suspend fun <M : ModalForm> Extension.publicMessageCommand(modal: () -> M, body: suspend PublicMessageCommand<M>.() -> Unit): PublicMessageCommand<M>

Register a public message command, DSL-style.

Link copied to clipboard
suspend fun <T : Arguments, M : ModalForm> Extension.publicSlashCommand(commandObj: PublicSlashCommand<T, M>): PublicSlashCommand<T, M>

Function for registering a custom public slash command object.

suspend fun Extension.publicSlashCommand(body: suspend PublicSlashCommand<Arguments, ModalForm>.() -> Unit): PublicSlashCommand<Arguments, ModalForm>

DSL function for easily registering a public slash command, without arguments.

suspend fun <T : Arguments> Extension.publicSlashCommand(arguments: () -> T, body: suspend PublicSlashCommand<T, ModalForm>.() -> Unit): PublicSlashCommand<T, ModalForm>

DSL function for easily registering a public slash command, with arguments.

@JvmName(name = "publicSlashCommand1")
suspend fun <M : ModalForm> Extension.publicSlashCommand(modal: () -> M, body: suspend PublicSlashCommand<Arguments, M>.() -> Unit): PublicSlashCommand<Arguments, M>

DSL function for easily registering a public slash command, with a modal form.

suspend fun <A : Arguments, M : ModalForm> Extension.publicSlashCommand(arguments: () -> A, modal: () -> M, body: suspend PublicSlashCommand<A, M>.() -> Unit): PublicSlashCommand<A, M>

DSL function for easily registering a public slash command, with arguments and a modal form.

Link copied to clipboard
suspend fun <M : ModalForm> Extension.publicUserCommand(commandObj: PublicUserCommand<M>): PublicUserCommand<M>

Register a custom instance of a public user command.

suspend fun Extension.publicUserCommand(body: suspend PublicUserCommand<ModalForm>.() -> Unit): PublicUserCommand<ModalForm>
suspend fun <M : ModalForm> Extension.publicUserCommand(modal: () -> M, body: suspend PublicUserCommand<M>.() -> Unit): PublicUserCommand<M>

Register a public user command, DSL-style.

Link copied to clipboard
fun Extension.slashCommandCheck(vararg checks: SlashCommandCheck)

Define a check which must pass for a slash command to be executed. This check will be applied to all slash commands in this extension.

fun Extension.slashCommandCheck(check: SlashCommandCheck)

Overloaded slash command check function to allow for DSL syntax.

Link copied to clipboard
fun Extension.userCommandCheck(vararg checks: UserCommandCheck)

Define a check which must pass for a user command to be executed. This check will be applied to all user commands in this extension.

fun Extension.userCommandCheck(check: UserCommandCheck)

Overloaded user command check function to allow for DSL syntax.