ModalSubmitInteraction

Properties

Link copied to clipboard

The ActionRowComponents of the modal containing the values submitted by the user.

Link copied to clipboard
open override val applicationId: Snowflake

The id of the application the interaction is for.

Link copied to clipboard

Attachment size limit in bytes

Link copied to clipboard

Map of the authorizing users id by type.

Link copied to clipboard

The behavior of the channel the interaction was sent from.

Link copied to clipboard
open override val channelId: Snowflake

The id of the channel the interaction was sent from.

Link copied to clipboard

The ChannelSelectComponents of the modal, indexed by their customId. They contain the values submitted by the user.

Link copied to clipboard

The CheckboxComponents of the modal, indexed by their customId.

Link copied to clipboard

The CheckboxGroupComponents of the modal, indexed by their customId. They contain the options submitted by the user.

Link copied to clipboard

Context where the interaction was triggered from.

Link copied to clipboard
abstract val data: InteractionData
Link copied to clipboard

For monetized apps, any Entitlements for the invoking user, representing access to premium Skus.

Link copied to clipboard

The FileUploadComponents of the modal, indexed by their customId. They contain the value ids submitted by the user.

Link copied to clipboard
open val guildLocale: Locale?

The guild's preferred locale, if invoked in a guild.

Link copied to clipboard
open override val id: Snowflake

The unique identifier of this entity.

Link copied to clipboard
abstract val kord: Kord

The kord instance that created this object.

Link copied to clipboard
open val locale: Locale?

The selected language of the invoking user.

Link copied to clipboard

The MentionableSelectComponents of the modal, indexed by their customId. They contain the values submitted by the user.

Link copied to clipboard
open val message: Message?

The message the Component, to which the modal was the response for, is attached to.

Link copied to clipboard
open val modalId: String

The custom id of the modal.

Link copied to clipboard

The RadioGroupComponents of the modal, indexed by their customId. They contain the options submitted by the user.

Link copied to clipboard

The ResolvedObjects for the interaction event.

Link copied to clipboard

The Components of the modal, containing the values submitted by the user in their respective subclasses, indexed by their customId (if present).

Link copied to clipboard

The RoleSelectComponents of the modal, indexed by their customId. They contain the values submitted by the user.

Link copied to clipboard

The StringSelectComponents of the modal, indexed by their customId. They contain the values submitted by the user.

Link copied to clipboard
abstract val supplier: EntitySupplier

The supplier used to request entities.

Link copied to clipboard

The TextInputComponents of the modal, indexed by their customId. They contain the values submitted by the user.

Link copied to clipboard

The TextInputComponents of the modal, indexed by their customId. They contain the values submitted by the user.

Link copied to clipboard
open override val token: String

A continuation token for responding to the interaction.

Link copied to clipboard

The type of the interaction.

Link copied to clipboard
abstract val user: User

The invoker of the interaction.

Link copied to clipboard

The UserSelectComponents of the modal, indexed by their customId. They contain the values submitted by the user.

Link copied to clipboard
open val version: Int

read-only property, always 1

Functions

Link copied to clipboard
open operator override fun compareTo(other: Entity): Int

Compares entities on id.

Link copied to clipboard

Acknowledges the interaction with the intent of updating the original ephemeral message later by calling edit on the returned object.

Link copied to clipboard

Acknowledges the interaction with the intent of responding with an ephemeral message later by calling respond on the returned object.

Link copied to clipboard

Acknowledges the interaction with the intent of responding with an ephemeral message later by calling edit on the returned object.

Link copied to clipboard

Acknowledges the interaction with the intent of updating the original public message later by calling edit on the returned object.

Link copied to clipboard

Acknowledges the interaction with the intent of responding with a public message later by calling respond on the returned object.

Link copied to clipboard

Acknowledges the interaction with the intent of responding with a public message later by calling edit on the returned object.

Link copied to clipboard
open suspend fun getChannel(): MessageChannel
Link copied to clipboard
open suspend fun getChannelOrNull(): MessageChannel?
Link copied to clipboard

Returns the initial interaction response.

Link copied to clipboard

Returns the initial interaction response or null if it was not found.

Link copied to clipboard
open suspend fun openActivity()

Opens the Activity of this application.

Link copied to clipboard
Link copied to clipboard

Responds to the interaction with a public message.

Link copied to clipboard

Responds to the interaction by updating the original ephemeral message.

Link copied to clipboard

Responds to the interaction by updating the original public message.

Link copied to clipboard
abstract override fun withStrategy(strategy: EntitySupplyStrategy<*>): ModalSubmitInteraction

Returns a copy of this class with a new supplier provided by the strategy.