kord-core/dev.kord.core.builder.kord/KordBuilder

KordBuilder

expect class KordBuilder(val token: String) : BaseKordBuilder(source)

actual class KordBuilder(val token: String) : BaseKordBuilder(source)

Constructors

KordBuilder

expect constructor(token: String)

actual constructor(token: String)

Properties

applicationId

var applicationId: Snowflake?

defaultDispatcher

var defaultDispatcher: CoroutineDispatcher

The CoroutineDispatcher kord uses to launch suspending tasks. Dispatchers.Default by default.

var defaultDispatcher: CoroutineDispatcher

The CoroutineDispatcher kord uses to launch suspending tasks. Dispatchers.Default by default.

var defaultDispatcher: CoroutineDispatcher

The CoroutineDispatcher kord uses to launch suspending tasks. Dispatchers.Default by default.

defaultStrategy

var defaultStrategy: EntitySupplyStrategy<*>

The default strategy used by entities to retrieve entities. EntitySupplyStrategy.cacheWithRestFallback by default.

var defaultStrategy: EntitySupplyStrategy<*>

The default strategy used by entities to retrieve entities. EntitySupplyStrategy.cacheWithRestFallback by default.

var defaultStrategy: EntitySupplyStrategy<*>

The default strategy used by entities to retrieve entities. EntitySupplyStrategy.cacheWithRestFallback by default.

enableShutdownHook

var enableShutdownHook: Boolean

Enable adding a Runtime.addShutdownHook to log out of the Gateway when the process is killed.

eventFlow

var eventFlow: MutableSharedFlow<Event>

The event flow used by Kord.eventFlow to publish events.

var eventFlow: MutableSharedFlow<Event>

The event flow used by Kord.eventFlow to publish events.

var eventFlow: MutableSharedFlow<Event>

The event flow used by Kord.eventFlow to publish events.

gatewayEventInterceptor

var gatewayEventInterceptor: GatewayEventInterceptor?

The GatewayEventInterceptor used for converting gateway events to core events.

var gatewayEventInterceptor: GatewayEventInterceptor?

The GatewayEventInterceptor used for converting gateway events to core events.

var gatewayEventInterceptor: GatewayEventInterceptor?

The GatewayEventInterceptor used for converting gateway events to core events.

httpClient

var httpClient: HttpClient?

The client used for building Gateways and RequestHandlers. A default implementation will be used when not set.

var httpClient: HttpClient?

The client used for building Gateways and RequestHandlers. A default implementation will be used when not set.

var httpClient: HttpClient?

The client used for building Gateways and RequestHandlers. A default implementation will be used when not set.

stackTraceRecovery

var stackTraceRecovery: Boolean

Enables stack trace recovery on the currently defined RequestHandler.

var stackTraceRecovery: Boolean

Enables stack trace recovery on the currently defined RequestHandler.

var stackTraceRecovery: Boolean

Enables stack trace recovery on the currently defined RequestHandler.

token

val token: String

Functions

build

open suspend fun build(): Kord

open suspend override fun build(): Kord

cache

fun cache(builder: KordCacheBuilder.(resources: ClientResources) -> Unit)

Configures the DataCache for caching.

fun cache(builder: KordCacheBuilder.(resources: ClientResources) -> Unit)

Configures the DataCache for caching.

fun cache(builder: KordCacheBuilder.(resources: ClientResources) -> Unit)

Configures the DataCache for caching.

gateways

fun gateways(gatewayBuilder: (resources: ClientResources, shards: List<Int>) -> List<Gateway>)

Configures the Gateway for each shard.

fun gateways(gatewayBuilder: (resources: ClientResources, shards: List<Int>) -> List<Gateway>)

Configures the Gateway for each shard.

fun gateways(gatewayBuilder: (resources: ClientResources, shards: List<Int>) -> List<Gateway>)

Configures the Gateway for each shard.

requestHandler

fun requestHandler(handlerBuilder: (resources: ClientResources) -> RequestHandler)

Configures the RequestHandler for the RestClient.

fun requestHandler(handlerBuilder: (resources: ClientResources) -> RequestHandler)

Configures the RequestHandler for the RestClient.

fun requestHandler(handlerBuilder: (resources: ClientResources) -> RequestHandler)

Configures the RequestHandler for the RestClient.

sharding

fun sharding(shards: (recommended: Int) -> Shards)

Configures the shards this client will connect to, by default 0 until recommended. This can be used to break up to client into multiple processes.

fun sharding(shards: (recommended: Int) -> Shards)

Configures the shards this client will connect to, by default 0 until recommended. This can be used to break up to client into multiple processes.

fun sharding(shards: (recommended: Int) -> Shards)

Configures the shards this client will connect to, by default 0 until recommended. This can be used to break up to client into multiple processes.