BotCommands-core/io.github.freya022.botcommands.api.core/BContext

BContext

@InterfacedService(acceptMultiple = false)

interface BContext(source)

Main context for BotCommands framework.

Types

Status

enum Status : Enum<BContext.Status>

Initialization status of the framework.

Properties

appEmojisConfig

open val appEmojisConfig: BAppEmojisConfig

applicationCommandsContext

abstract val applicationCommandsContext: ApplicationCommandsContext

Returns the application commands context, this is for user/message/slash commands and related methods

applicationConfig

open val applicationConfig: BApplicationConfig

botOwners

abstract val botOwners: BotOwners

Returns the BotOwners service.

componentsConfig

open val componentsConfig: BComponentsConfig

config

abstract val config: BConfig

coroutineScopesConfig

open val coroutineScopesConfig: BCoroutineScopesConfig

eventDispatcher

abstract val eventDispatcher: EventDispatcher

Returns the EventDispatcher service.

eventManagerConfig

open val eventManagerConfig: BEventManagerConfig

globalExceptionHandler

abstract val globalExceptionHandler: GlobalExceptionHandler?

Returns the global exception handler, used to handle errors caught by the framework, or null if none exists.

jda

open val jda: JDA

Returns the JDA instance associated with this context.

localizationConfig

open val localizationConfig: BLocalizationConfig

serviceConfig

open val serviceConfig: BServiceConfig

serviceContainer

abstract val serviceContainer: ServiceContainer

Returns the ServiceContainer service.

status

abstract val status: BContext.Status

Returns the status of the framework.

textCommandsContext

abstract val textCommandsContext: TextCommandsContext

Returns the TextCommandsContext service.

textConfig

open val textConfig: BTextConfig

Functions

awaitShutdown

open fun awaitShutdown(): Boolean

Blocks the current thread until the status is set to SHUTDOWN.

open fun awaitShutdown(timeout: Duration): Boolean

abstract fun awaitShutdown(timeout: Duration): Boolean

open fun awaitShutdown(timeout: Long, unit: TimeUnit): Boolean

Blocks the current thread until the status is set to SHUTDOWN, or until the timeout has been reached.

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.

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?

shutdown

abstract fun shutdown()

Shuts down this instance of BotCommands, shutting down JDA in the process, then shutting down all executors.

shutdownNow

abstract fun shutdownNow()

Immediately shuts down this instance of BotCommands, shutting down JDA in the process, then shutting down all executors.

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>