core/dev.kord.core.entity.component/ButtonComponent

ButtonComponent

class ButtonComponent(val data: ChatComponentData) : Component(source)

An interactive component rendered on a Message. If this button contains a customId and is clicked by a user, a InteractionCreateEvent with a ComponentInteraction will fire.

Constructors

ButtonComponent

fun ButtonComponent(data: ChatComponentData)

Functions

toString

open override fun toString(): String

Properties

customId

val customId: String?

The custom identifier for any ButtonInteraction this button will trigger. Present if this button is not a link button.

data

open override val data: ChatComponentData

disabled

val disabled: Boolean

Whether this button can be clicked.

emoji

val emoji: ReactionEmoji?

The emoji that appears on the button, if present.

label

val label: String?

The text that appears on the button, if present.

style

val style: ButtonStyle

The style of this button, ButtonStyle.Link buttons will always have a url.

type

open override val type: ComponentType.Button

The type of component.

url

val url: String?

The url the button will link to. Present if this button is a link button.