Returns the preferred prefix for triggering this bot, or null if BTextConfig.usePingAsPrefix is disabled and no prefix was added in BTextConfig.prefixes.

prefixes

open val ~~prefixes~~: List<String>

Returns the full list of prefixes used to trigger the bot.

serviceConfig

open val serviceConfig: BServiceConfig

serviceContainer

abstract val serviceContainer: ServiceContainer

Returns the ServiceContainer service.

settingsProvider

abstract val settingsProvider: SettingsProvider?

Returns the SettingsProvider service, or null if none exists.

status

abstract val status: BContext.Status

Returns the initialization status of the framework.

textCommandsContext

abstract val textCommandsContext: TextCommandsContext

Returns the TextCommandsContext service.

textConfig

open val textConfig: BTextConfig

Functions

canCreateService

inline fun <T : Any> BContext.canCreateService(): ServiceError?

fun <T : Any> BContext.canCreateService(kClass: KClass<T>): ServiceError?

dispatchException

open fun dispatchException(message: String, t: Throwable?)

abstract fun dispatchException(message: String, t: Throwable?, extraContext: Map<String, Any?>)

Sends an exception message to the bot owners.

getDefaultMessages

open fun ~~getDefaultMessages~~(guild: Guild?): DefaultMessages

Returns the DefaultMessages instance for this Guild's locale

open fun ~~getDefaultMessages~~(locale: DiscordLocale): DefaultMessages

Returns the DefaultMessages instance for the provided Discord locale.

open fun ~~getDefaultMessages~~(interaction: Interaction): DefaultMessages

Returns the DefaultMessages instance for this user's locale

getEffectiveLocale

open fun ~~getEffectiveLocale~~(guild: Guild?): DiscordLocale

Returns the DiscordLocale for the specified Guild

getExceptionContent

abstract fun getExceptionContent(message: String, t: Throwable?, extraContext: Map<String, Any?>): String

Gets the message that would be sent by dispatchException.

getInterfacedServices

inline fun <T : Any> BContext.getInterfacedServices(): List<T>

Filters out interfaced services of that type if they are already being inspected.

getInterfacedServiceTypes

inline fun <T : Any> BContext.getInterfacedServiceTypes(): List<KClass<out T>>

Filters out interfaced services of that type if they are already being inspected.

getService

open fun <T : Any> getService(clazz: Class<T>): T

getService

inline fun <T : Any> BContext.getService(): T

fun <T : Any> BContext.getService(kClass: KClass<T>): T

getServiceOrNull

inline fun <T : Any> BContext.getServiceOrNull(): T?

fun <T : Any> BContext.getServiceOrNull(kClass: KClass<T>): T?

invalidateAutocompleteCache

open fun ~~invalidateAutocompleteCache~~(autocompleteHandlerName: String)

open fun ~~invalidateAutocompleteCache~~(autocompleteHandler: KFunction<Collection<Any>>)

Invalidates the autocomplete cache of the specified autocomplete handler.

isOwner

open fun ~~isOwner~~(userId: Long): Boolean

Tells whether this user is an owner or not.

tryGetService

open fun <T : Any> tryGetService(clazz: Class<T>): ServiceResult<T>

tryGetService

inline fun <T : Any> BContext.tryGetService(): ServiceResult<T>

fun <T : Any> BContext.tryGetService(kClass: KClass<T>): ServiceResult<T>