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

Button

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

Properties

Link copied to clipboard
abstract val group: ComponentGroup?
Link copied to clipboard
abstract val internalId: Int

Functions

Link copied to clipboard
open override fun asDisabled(): Button
Link copied to clipboard
open override fun asEnabled(): Button
Link copied to clipboard
abstract suspend fun await(): ButtonEvent

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

Link copied to clipboard
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.

Link copied to clipboard
abstract override fun getCustomId(): String
Link copied to clipboard
@Nullable
abstract fun getEmoji(): EmojiUnion?
Link copied to clipboard
open override fun getId(): String
Link copied to clipboard
@Nonnull
abstract fun getLabel(): String
Link copied to clipboard
@Nullable
abstract fun getSku(): SkuSnowflake?
Link copied to clipboard
@Nonnull
abstract fun getStyle(): ButtonStyle
Link copied to clipboard
@Nonnull
abstract fun getType(): Component.Type
Link copied to clipboard
abstract fun getUniqueId(): Int
Link copied to clipboard
@Nullable
abstract fun getUrl(): String?
Link copied to clipboard
abstract override fun isDisabled(): Boolean
Link copied to clipboard
open fun isEnabled(): Boolean
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
abstract override fun withCustomId(customId: String): Button
Link copied to clipboard
abstract override fun withDisabled(disabled: Boolean): Button
Link copied to clipboard
abstract override fun withEmoji(emoji: Emoji?): Button
Link copied to clipboard
open override fun withId(id: String): Nothing
Link copied to clipboard
abstract override fun withLabel(label: String): Button
Link copied to clipboard
open override fun withSku(sku: SkuSnowflake): Nothing
Link copied to clipboard
abstract override fun withStyle(style: ButtonStyle): Button
Link copied to clipboard
abstract override fun withUniqueId(uniqueId: Int): Button
Link copied to clipboard
open override fun withUrl(url: String): Nothing