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

InteractionButtonWithID

abstract class InteractionButtonWithID : ComponentWithID, HasPartialEmoji

Abstract class representing a button component with an ID, but without a click action.

Inheritors

DisabledInteractionButton

Constructors

InteractionButtonWithID

constructor()

Properties

bot

val bot: ExtensibleBot

Bot object.

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.

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.

sentry

val sentry: SentryAdapter

Sentry adapter, for easy access to Sentry functions.

settings

val settings: ExtensibleBotBuilder

Bot settings object.

unitWidth

open val unitWidth: Int = 1

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

Functions

apply

abstract fun apply(builder: ActionRowBuilder)

Called to apply the given component to a Kord ActionRowBuilder.

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.

getKoin

open override fun getKoin(): Koin

Get the associated Koin instance.

validate

open override fun validate()

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