kord-extensions/dev.kordex.core.components/ComponentWithAction

ComponentWithAction

abstract class ComponentWithAction<E : ComponentInteractionCreateEvent, C : ComponentContext<*>, M : ModalForm>(val timeoutTask: Task?, val modal: () -> M? = null) : ComponentWithID, Lockable

Abstract class representing a component with both an ID and executable action.

Parameters

E

Event type that triggers interaction actions for this component type

C

Context type used for this component's execution context

M

Modal form type representing the ModalForm subtype used, if any.

timeoutTask

Timeout task that will be restarted when call is run, if any. This is intended to be used to in the timeout mechanism for the ComponentContainer that contains this component.

modal

Callback returning a ModalForm object, probably the constructor of a subtype.

Inheritors

InteractionButtonWithAction

Constructors

ComponentWithAction

constructor(timeoutTask: Task?, modal: () -> M? = null)

Properties

lateinit var body: suspend C.(modal: M?) -> Unit

Component body, to be called when the component is interacted with.

val bot: ExtensibleBot

Bot object.

open var deferredAck: Boolean

Whether to use a deferred ack, which will prevent Discord's "Thinking..." message.

open var id: String

Component's ID, a UUID by default.

val kord: Kord

Kord instance, backing the ExtensibleBot.

open override var locking: Boolean

Set this to true to lock execution with a Mutex.

open val modal: () -> M? = null

open override var mutex: Mutex?

Mutex object to use for locking.

val registry: ApplicationCommandRegistry

Quick access to the command registry.

open val requiredPerms: MutableSet<Permission>

Bot permissions required to be able to run execute this component's action.

val sentry: SentryAdapter

Sentry adapter, for easy access to Sentry functions.

val settings: ExtensibleBotBuilder

Bot settings object.

open val timeoutTask: Task?

open val unitWidth: Int = 1

Component width, how many "slots" in one row it needs to be added to the row.

Functions

fun action(action: suspend C.(modal: M?) -> Unit)

Call this to supply a component body, to be called when the component is interacted with.

abstract fun apply(builder: ActionRowBuilder)

Called to apply the given component to a Kord ActionRowBuilder.

open suspend fun call(event: E)

Override this to implement your component's calling logic. Check subtypes for examples!

open fun check(vararg checks: CheckWithCache<E>)

Define a check which must pass for the component's body to be executed.

open fun check(check: CheckWithCache<E>)

Overloaded check function to allow for DSL syntax.

open suspend fun checkBotPerms(context: C)

Checks whether the bot has the specified required permissions, throwing if it doesn't.

open override fun getKoin(): Koin

Get the associated Koin instance.

open suspend fun lock()

Lock the mutex, if locking is enabled - suspending until it's unlocked.

requireBotPermissions

fun requireBotPermissions(vararg perms: Permission)

If your bot requires permissions to be able to execute this component's body, add them using this function.

open suspend fun runChecks(event: E, cache: MutableStringKeyedMap<Any>): Boolean

Override this in order to implement any subclass-specific checks.

runStandardChecks

open suspend fun runStandardChecks(event: E, cache: MutableStringKeyedMap<Any>): Boolean

Runs standard checks that can be handled in a generic way, without worrying about subclass-specific checks.

open fun unlock()

Unlock the mutex, if it's locked.

open override fun validate()

Validation function, called to ensure the component is valid, throws exceptions if not.

open suspend fun <T> withLock(body: suspend () -> T)

Lock the mutex (if locking is enabled), call the supplied callable, and unlock.