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

UserCommandInteraction

sealed interface UserCommandInteraction : ApplicationCommandInteraction(source)

An ApplicationCommandInteraction created when a user uses a UserCommand.

Inheritors

GuildUserCommandInteraction

GlobalUserCommandInteraction

Properties

applicationId

open override val applicationId: Snowflake

The id of the application the interaction is for.

channel

open val channel: MessageChannelBehavior

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.

data

abstract val data: InteractionData

entitlements

open val entitlements: List<Entitlement>

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

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.

invokedCommandGuildId

open val invokedCommandGuildId: Snowflake?

The id of the guild the invoked command is registered to, null if the command is global.

invokedCommandId

open val invokedCommandId: Snowflake

The id of the invoked command.

invokedCommandName

open val invokedCommandName: String

The name of the invoked command.

invokedCommandType

open val invokedCommandType: ApplicationCommandType

The type of the invoked command.

kord

abstract val kord: Kord

The kord instance that created this object.

locale

open val locale: Locale?

The selected language of the invoking user.

resolvedObjects

open val resolvedObjects: ResolvedObjects?

supplier

abstract val supplier: EntitySupplier

The supplier used to request entities.

target

open val target: UserBehavior

The behavior of the user targeted by the UserCommand.

targetId

open val targetId: Snowflake

The id of the user targeted by the UserCommand.

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

abstract val user: User

The invoker of the interaction.

users

open val users: Map<Snowflake, 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.

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.

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.

getChannel

open suspend fun getChannel(): MessageChannel

getChannelOrNull

open suspend fun getChannelOrNull(): MessageChannel?

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.

getTarget

open suspend fun getTarget(): User

getTargetOrNull

open suspend fun getTargetOrNull(): User?

modal

inline suspend fun ModalParentInteractionBehavior.modal(title: String, customId: String, builder: ModalBuilder.() -> Unit): PopupInteractionResponseBehavior

Responds to the interaction with a popup modal.

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.

withStrategy

abstract override fun withStrategy(strategy: EntitySupplyStrategy<*>): UserCommandInteraction

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