kord-extensions/dev.kordex.core.builders/ExtensibleBotBuilder

ExtensibleBotBuilder

Builder class used for configuring and creating an ExtensibleBot.

This is a one-stop-shop for pretty much everything you could possibly need to change to configure your bot, via properties and a bunch of DSL functions.

Constructors

constructor()

Properties

addDefaultHealthChecks

var addDefaultHealthChecks: Boolean

Whether to add KordEx's default health-checks. Defaults to true.

autoCompleteContextThreads

var autoCompleteContextThreads: Int

The number of threads to use for autocomplete event coroutines.

botVersion

var botVersion: String?

The bot's version. Set this yourself manually or use the KordEx Gradle plugin.

constructor

var constructor: (ExtensibleBotBuilder, String) -> ExtensibleBot

Called to create an ExtensibleBot, can be set to the constructor of your own subtype if needed.

dataCollectionMode

var dataCollectionMode: DataCollection

Data collection mode, usually configured in other ways, but you may override that configuration here.

devMode

var devMode: Boolean

Whether the bot is running in development mode.

interactionContextThreads

var interactionContextThreads: Int

The number of threads to use for interaction event coroutines.

koinLogLevel

var koinLogLevel: Level

Logging level Koin should use, defaulting to ERROR.

Functions

about

suspend fun about(builder: suspend AboutBuilder.() -> Unit)

DSL function used to configure information about the bot.

applicationCommands

suspend fun applicationCommands(builder: suspend ApplicationCommandsBuilder.() -> Unit)

DSL function used to configure the bot's application command options.

cache

suspend fun cache(builder: suspend CacheBuilder.() -> Unit)

DSL function used to configure the bot's caching options.

chatCommands

suspend fun chatCommands(builder: suspend ChatCommandsBuilder.() -> Unit)

DSL function used to configure the bot's chat command options.

components

suspend fun components(builder: suspend ComponentsBuilder.() -> Unit)

DSL function used to configure the bot's components system.

customKordBuilder

fun customKordBuilder(builder: suspend (token: String, builder: suspend KordBuilder.() -> Unit) -> Kord)

Function allowing you to specify a callable that constructs and returns a Kord instance. This can be used to specify your own Kord subclass, if you need to - but shouldn't be a replacement for registering a kord configuration builder.

dataAdapter

fun dataAdapter(builder: () -> DataAdapter<*>)

Call this to register a custom data adapter class. Generally you'd pass a constructor here, but you can also provide a lambda if needed.

errorResponse

fun errorResponse(builder: FailureResponseBuilder)

Register the message builder responsible for formatting error responses, which are sent to users during command and component body execution.

extensions

open suspend fun extensions(builder: suspend ExtensionsBuilder.() -> Unit)

DSL function used to configure the bot's extension options, and add extensions. Calls to this function do not run immediately, so that plugins can be loaded beforehand.

hooks