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

AutoCompleteInteraction

sealed interface AutoCompleteInteraction : DataInteraction, AutoCompleteInteractionBehavior(source)

A DataInteraction indicating an auto-complete request from Discord.

No matter what argument type is used all focused arguments will be CommandArgument.AutoCompleteArguments.

Check AutoCompleteInteractionBehavior for response options.

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
open val command: InteractionCommand

An InteractionCommand that contains the values the user filled so far.

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 focusedOption: StringOptionValue

The single focused option the user is currently typing.

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 getChannel(): MessageChannel
Link copied to clipboard
open suspend fun getChannelOrNull(): MessageChannel?
Link copied to clipboard
suspend fun AutoCompleteInteractionBehavior.suggest(choices: List<Choice>)

Responds to the interaction with choices to this auto-complete request.

Link copied to clipboard
inline suspend fun AutoCompleteInteractionBehavior.suggestInteger(builder: IntegerOptionBuilder.() -> Unit)

Responds to the interaction with the integer choices specified by builder.

Link copied to clipboard
inline suspend fun AutoCompleteInteractionBehavior.suggestNumber(builder: NumberOptionBuilder.() -> Unit)

Responds to the interaction with the number choices specified by builder.

Link copied to clipboard
inline suspend fun AutoCompleteInteractionBehavior.suggestString(builder: StringChoiceBuilder.() -> Unit)

Responds to the interaction with the string choices specified by builder.

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

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