kord-extensions/dev.kordex.core.components.buttons/EphemeralInteractionButton

EphemeralInteractionButton

open class EphemeralInteractionButton<M : ModalForm>(timeoutTask: Task?, val modal: () -> M? = null) : InteractionButtonWithAction<EphemeralInteractionButtonContext<M>, M>

Class representing an ephemeral-only interaction button.

Constructors

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

Properties

body

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

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

bot

val bot: ExtensibleBot

Bot object.

deferredAck

open var deferredAck: Boolean

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

disabled

open var disabled: Boolean

Whether this button is disabled.

open var id: String

Component's ID, a UUID by default.

kord

val kord: Kord

Kord instance, backing the ExtensibleBot.

label

var label: Key?

Button label, for display on Discord.

locking

open override var locking: Boolean

Set this to true to lock execution with a Mutex.

modal

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

mutex

open override var mutex: Mutex?

Mutex object to use for locking.

partialEmoji

open override var partialEmoji: DiscordPartialEmoji?

A partial emoji object, either a guild or Unicode emoji. Optional if you've got a label.

registry

val registry: ApplicationCommandRegistry

Quick access to the command registry.

requiredPerms

open val requiredPerms: MutableSet<Permission>

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

sentry

val sentry: SentryAdapter

Sentry adapter, for easy access to Sentry functions.

settings

val settings: ExtensibleBotBuilder

Bot settings object.

style

open var style: ButtonStyle

Button style - anything but Link or Premium is valid.

timeoutTask

open val timeoutTask: Task?

unitWidth

open val unitWidth: Int

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

Functions

action

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

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

apply

open override fun apply(builder: ActionRowBuilder)

Called to apply the given component to a Kord ActionRowBuilder.

call

open suspend override fun call(event: ButtonInteractionCreateEvent)

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

check

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

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

open fun check(check: CheckWithCache<ButtonInteractionCreateEvent>)

Overloaded check function to allow for DSL syntax.

checkBotPerms

open suspend fun checkBotPerms(context: EphemeralInteractionButtonContext<M>)

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

disable

open fun disable()

Mark this button as disabled.

emoji

fun HasPartialEmoji.emoji(guildEmoji: GuildEmoji)

Convenience function for setting HasPartialEmoji.partialEmoji based on a given guild custom emoji.

fun HasPartialEmoji.emoji(emoji: ReactionEmoji)

fun HasPartialEmoji.emoji(guildEmoji: ReactionEmoji.Custom)

fun HasPartialEmoji.emoji(unicodeEmoji: ReactionEmoji.Unicode)

Convenience function for setting HasPartialEmoji.partialEmoji based on a given reaction emoji.

fun HasPartialEmoji.emoji(unicodeEmoji: String)

Convenience function for setting HasPartialEmoji.partialEmoji based on a given Unicode emoji.

enable

open fun enable()

Mark this button as enabled.

firstSentryBreadcrumb

open suspend fun firstSentryBreadcrumb(context: EphemeralInteractionButtonContext<M>, button: InteractionButtonWithAction<*, *>)

If enabled, adds the initial Sentry breadcrumb to the given context.

getKoin

open override fun getKoin(): Koin

Get the associated Koin instance.

handleError

open suspend fun handleError(context: EphemeralInteractionButtonContext<M>, t: Throwable, button: InteractionButtonWithAction<*, *>)

A general way to handle errors thrown during the course of a button action's execution.

initialResponse

fun initialResponse(body: InitialEphemeralButtonResponseBuilder)

Call this to open with a response, omit it to ack instead.

lock

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.

respondText

open suspend override fun respondText(context: EphemeralInteractionButtonContext<M>, message: Key, failureType: FailureReason<*>)

Override this to implement a way to respond to the user, regardless of whatever happens.

runChecks

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

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

runStandardChecks

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

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

unlock

open fun unlock()

Unlock the mutex, if it's locked.

validate

open override fun validate()

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

withLock

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

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