kord-common/dev.kord.common.entity/DiscordComponent

DiscordComponent

@Serializable(with = DiscordComponent.Serializer::class)
sealed class DiscordComponent(source)

Represent a interactable component within a message sent in Discord.

Inheritors

Properties

Link copied to clipboard
@SerialName(value = "channel_types")
abstract val channelTypes: Optional<List<ChannelType>>

List of channel types to include in the channel select component (ComponentType.ChannelSelect)

Link copied to clipboard
abstract val components: Optional<List<DiscordComponent>>

a list of child components (for action rows)

Link copied to clipboard
@SerialName(value = "custom_id")
abstract val customId: Optional<String>

a developer-defined identifier for the button, max 100 characters

Link copied to clipboard
@SerialName(value = "default_values")
abstract val defaultValues: Optional<List<DiscordSelectDefaultValue>>
Link copied to clipboard
abstract val disabled: OptionalBoolean

whether the button is disabled, default false

Link copied to clipboard
abstract val emoji: Optional<DiscordPartialEmoji>

an DiscordPartialEmoji that appears on the button (if the component is a button)

Link copied to clipboard
abstract val label: Optional<String>
Link copied to clipboard
@SerialName(value = "max_length")
abstract val maxLength: OptionalInt

the maximum input length for a text input, min 1, max 4000.

Link copied to clipboard
@SerialName(value = "max_values")
abstract val maxValues: OptionalInt

the maximum amount of options allowed

Link copied to clipboard
@SerialName(value = "min_length")
abstract val minLength: OptionalInt

the minimum input length for a text input, min 0, max 4000.

Link copied to clipboard
@SerialName(value = "min_values")
abstract val minValues: OptionalInt

the minimum amount of options allowed

Link copied to clipboard
abstract val options: Optional<List<DiscordSelectOption>>

the select menu options

Link copied to clipboard
abstract val placeholder: Optional<String>

the placeholder text for the select menu

Link copied to clipboard
abstract val required: OptionalBoolean

whether this component is required to be filled, default false.

Link copied to clipboard
abstract val type: ComponentType

the ComponentType of the component

Link copied to clipboard
abstract val url: Optional<String>

a url for link-style buttons

Link copied to clipboard
abstract val value: Optional<String>

a pre-filled value for this component, max 4000 characters.