kord-common/dev.kord.common.entity/DiscordTextInputComponent

DiscordTextInputComponent

data class DiscordTextInputComponent(val type: ComponentType, val style: Optional<TextInputStyle> = Optional.Missing(), val label: Optional<String> = Optional.Missing(), val emoji: Optional<DiscordPartialEmoji> = Optional.Missing(), val customId: Optional<String> = Optional.Missing(), val url: Optional<String> = Optional.Missing(), val disabled: OptionalBoolean = OptionalBoolean.Missing, val components: Optional<List<DiscordComponent>> = Optional.Missing(), val options: Optional<List<DiscordSelectOption>> = Optional.Missing(), val placeholder: Optional<String> = Optional.Missing(), val defaultValues: Optional<List<DiscordSelectDefaultValue>> = Optional.Missing(), val minValues: OptionalInt = OptionalInt.Missing, val maxValues: OptionalInt = OptionalInt.Missing, val minLength: OptionalInt = OptionalInt.Missing, val maxLength: OptionalInt = OptionalInt.Missing, val required: OptionalBoolean = OptionalBoolean.Missing, val value: Optional<String> = Optional.Missing(), val channelTypes: Optional<List<ChannelType>> = Optional.Missing()) : DiscordComponent(source)

Constructors

DiscordTextInputComponent

constructor(type: ComponentType, style: Optional<TextInputStyle> = Optional.Missing(), label: Optional<String> = Optional.Missing(), emoji: Optional<DiscordPartialEmoji> = Optional.Missing(), customId: Optional<String> = Optional.Missing(), url: Optional<String> = Optional.Missing(), disabled: OptionalBoolean = OptionalBoolean.Missing, components: Optional<List<DiscordComponent>> = Optional.Missing(), options: Optional<List<DiscordSelectOption>> = Optional.Missing(), placeholder: Optional<String> = Optional.Missing(), defaultValues: Optional<List<DiscordSelectDefaultValue>> = Optional.Missing(), minValues: OptionalInt = OptionalInt.Missing, maxValues: OptionalInt = OptionalInt.Missing, minLength: OptionalInt = OptionalInt.Missing, maxLength: OptionalInt = OptionalInt.Missing, required: OptionalBoolean = OptionalBoolean.Missing, value: Optional<String> = Optional.Missing(), channelTypes: Optional<List<ChannelType>> = Optional.Missing())

Properties

@SerialName(value = "channel_types")

open override val channelTypes: Optional<List<ChannelType>>

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

open override val components: Optional<List<DiscordComponent>>

a list of child components (for action rows)

@SerialName(value = "custom_id")

open override val customId: Optional<String>

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

@SerialName(value = "default_values")

open override val defaultValues: Optional<List<DiscordSelectDefaultValue>>

open override val disabled: OptionalBoolean

whether the button is disabled, default false

open override val emoji: Optional<DiscordPartialEmoji>

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

open override val label: Optional<String>

@SerialName(value = "max_length")

open override val maxLength: OptionalInt

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

@SerialName(value = "max_values")

open override val maxValues: OptionalInt

the maximum amount of options allowed

@SerialName(value = "min_length")

open override val minLength: OptionalInt

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

@SerialName(value = "min_values")

open override val minValues: OptionalInt

the minimum amount of options allowed

open override val options: Optional<List<DiscordSelectOption>>

the select menu options

open override val placeholder: Optional<String>

the placeholder text for the select menu

open override val required: OptionalBoolean

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

val style: Optional<TextInputStyle>

open override val type: ComponentType

the ComponentType of the component

open override val url: Optional<String>

a url for link-style buttons

open override val value: Optional<String>

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