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

ActionInteraction

sealed interface ActionInteraction : Interaction, ActionInteractionBehavior(source)

An Interaction created when a user performs some form of action (e.g. using a slash command or pressing a button).

See also

Inheritors

Properties

Link copied to clipboard
open override val applicationId: Snowflake

The id of the application the interaction is for.

Link copied to clipboard
open val channel: MessageChannelBehavior

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
abstract val data: InteractionData
Link copied to clipboard
open val entitlements: List<Entitlement>

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

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
abstract val supplier: EntitySupplier

The supplier used to request entities.

Link copied to clipboard
open override val token: String

A continuation token for responding to the interaction.

Link copied to clipboard
open val type: InteractionType

The type of the interaction.

Link copied to clipboard
abstract val user: User

The invoker of the interaction.

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
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.

Link copied to clipboard
@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.

Link copied to clipboard
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.

Link copied to clipboard
@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.

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

Returns the initial interaction response.

Link copied to clipboard
open suspend fun getOriginalInteractionResponseOrNull(): Message?

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

Link copied to clipboard
inline suspend fun ActionInteractionBehavior.respondEphemeral(builder: InteractionResponseCreateBuilder.() -> Unit): EphemeralMessageInteractionResponseBehavior

Responds to the interaction with an ephemeral message.

Link copied to clipboard
inline suspend fun ActionInteractionBehavior.respondPublic(builder: InteractionResponseCreateBuilder.() -> Unit): PublicMessageInteractionResponseBehavior

Responds to the interaction with a public message.

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

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