kord-core/dev.kord.core.entity.interaction/GuildModalSubmitInteraction

GuildModalSubmitInteraction

class GuildModalSubmitInteraction(val data: InteractionData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : ModalSubmitInteraction, GuildInteraction(source)

A ModalSubmitInteraction that took place in the context of a Guild.

Constructors

constructor(data: InteractionData, kord: Kord, supplier: EntitySupplier = kord.defaultSupplier)

Properties

actionRows

open val actionRows: List<ActionRowComponent>

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

applicationId

open override val applicationId: Snowflake

The id of the application the interaction is for.

appPermissions

open val appPermissions: Permissions

Permissions the application has within the channel the interaction was sent from.

channel

open val channel: GuildMessageChannelBehavior

The behavior of the channel the interaction was sent from.

channelId

open override val channelId: Snowflake

The id of the channel the interaction was sent from.

channelSelects

open val channelSelects: Map<String, ChannelSelectComponent>

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

checkboxes

open val checkboxes: Map<String, CheckboxComponent>

The CheckboxComponents of the modal, indexed by their customId.

checkboxGroups

open val checkboxGroups: Map<String, CheckboxGroupComponent>

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

data

open override val data: InteractionData

entitlements

open val entitlements: List<Entitlement>

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

fileUploads

open val fileUploads: Map<String, FileUploadComponent>

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

guild

open val guild: GuildBehavior

The behavior of the guild the interaction was sent from.

guildId

open override val guildId: Snowflake

The id of the guild the interaction was sent from.

guildLocale

open val guildLocale: Locale?

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

open override val id: Snowflake

The unique identifier of this entity.

kord

open override val kord: Kord

The kord instance that created this object.

locale

open val locale: Locale?

The selected language of the invoking user.

mentionableSelects

open val mentionableSelects: Map<String, MentionableSelectComponent>

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

message

open val message: Message?

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

modalId

open val modalId: String

The custom id of the modal.

permissions

open val permissions: Permissions

Permissions the interaction invoker has within the channel the interaction was sent from.

radioGroups

open val radioGroups: Map<String, RadioGroupComponent>

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

resolvedObjects

open val resolvedObjects: ResolvedObjects?

The ResolvedObjects for the interaction event.

responseComponents

open val responseComponents: Map<String, Component>

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

roleSelects

open val roleSelects: Map<String, RoleSelectComponent>

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

stringSelects

open val stringSelects: Map<String, StringSelectComponent>

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

supplier

open override val supplier: EntitySupplier

The supplier used to request entities.

textInputs

open val textInputs: Map<String, TextInputComponent>

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

textInputs0

open val ~~textInputs0~~: Map<String, TextInputComponent>

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

token

open override val token: String

A continuation token for responding to the interaction.

type

open val type: InteractionType

The type of the interaction.

user

open val user: Member

The invoker of the interaction as a Member.

userSelects

open val userSelects: Map<String, UserSelectComponent>

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

version

open val version: Int

read-only property, always 1

Functions

compareTo

open operator override fun compareTo(other: Entity): Int

Compares entities on id.

deferEphemeralMessageUpdate

open suspend fun deferEphemeralMessageUpdate(): EphemeralMessageInteractionResponseBehavior

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

deferEphemeralResponse

open suspend fun deferEphemeralResponse(): DeferredEphemeralMessageInteractionResponseBehavior

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

deferEphemeralResponseUnsafe

@KordUnsafe

open suspend fun deferEphemeralResponseUnsafe(): EphemeralMessageInteractionResponseBehavior

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

deferPublicMessageUpdate

open suspend fun deferPublicMessageUpdate(): PublicMessageInteractionResponseBehavior

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

deferPublicResponse

open suspend fun deferPublicResponse(): DeferredPublicMessageInteractionResponseBehavior

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

deferPublicResponseUnsafe

@KordUnsafe

open suspend fun deferPublicResponseUnsafe(): PublicMessageInteractionResponseBehavior

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

equals

open operator override fun equals(other: Any?): Boolean

getChannel

open suspend fun getChannel(): GuildMessageChannel

getChannelOrNull

open suspend fun getChannelOrNull(): GuildMessageChannel?

getGuild

open suspend fun getGuild(): Guild

getGuildOrNull

open suspend fun getGuildOrNull(): Guild?

getOriginalInteractionResponse

open suspend fun getOriginalInteractionResponse(): Message

Returns the initial interaction response.

getOriginalInteractionResponseOrNull

open suspend fun getOriginalInteractionResponseOrNull(): Message?

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

hashCode

open override fun hashCode(): Int

respondEphemeral

inline suspend fun ActionInteractionBehavior.respondEphemeral(builder: InteractionResponseCreateBuilder.() -> Unit): EphemeralMessageInteractionResponseBehavior

Responds to the interaction with an ephemeral message.

respondPublic

inline suspend fun ActionInteractionBehavior.respondPublic(builder: InteractionResponseCreateBuilder.() -> Unit): PublicMessageInteractionResponseBehavior

Responds to the interaction with a public message.

toString

open override fun toString(): String

updateEphemeralMessage

inline suspend fun ComponentInteractionBehavior.updateEphemeralMessage(builder: UpdateMessageInteractionResponseCreateBuilder.() -> Unit): EphemeralMessageInteractionResponseBehavior

Responds to the interaction by updating the original ephemeral message.

updatePublicMessage

inline suspend fun ComponentInteractionBehavior.updatePublicMessage(builder: UpdateMessageInteractionResponseCreateBuilder.() -> Unit): PublicMessageInteractionResponseBehavior

Responds to the interaction by updating the original public message.

withStrategy

open override fun withStrategy(strategy: EntitySupplyStrategy<*>): GuildModalSubmitInteraction

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