BotCommands-core/io.github.freya022.botcommands.api.components/Button

Button

interface Button : Button, AwaitableComponent<ButtonEvent> , IGroupHolder(source)

Properties

abstract override val customId: String

@get:Nullable

abstract val emoji: EmojiUnion?

abstract val group: ComponentGroup?

abstract val internalId: Int

abstract val isDisabled: Boolean

open val isEnabled: Boolean

isMessageCompatible

open val isMessageCompatible: Boolean

isModalCompatible

open val isModalCompatible: Boolean

@get:Nonnull

abstract val label: String

@get:Nullable

abstract val sku: SkuSnowflake?

@get:Nonnull

abstract val style: ButtonStyle

@get:Nonnull

abstract val type: Component.Type

abstract val uniqueId: Int

@get:Nullable

abstract val url: String?

Functions

open override fun asDisabled(): Button

open override fun asEnabled(): Button

abstract suspend fun await(): ButtonEvent

Suspends until the component is used and all checks passed, and returns the event.

suspend fun <T : ComponentInteraction> AwaitableComponent<T>.awaitOrNull(): T?

Suspends until the component is used and all checks passed, and returns the event, or null if the timeout has been reached.

abstract override fun getCustomId(): String

toIdentifiableComponent

fun ICustomId.toIdentifiableComponent(): IdentifiableComponent

toIdentifiableComponentOrNull

fun ICustomId.toIdentifiableComponentOrNull(): IdentifiableComponent?

abstract override fun withCustomId(customId: String): Button

abstract override fun withDisabled(disabled: Boolean): Button

abstract override fun withEmoji(emoji: Emoji?): Button

abstract override fun withLabel(label: String): Button

open override fun withSku(sku: SkuSnowflake): Nothing

abstract override fun withStyle(style: ButtonStyle): Button

abstract override fun withUniqueId(uniqueId: Int): Button

open override fun withUrl(url: String): Nothing