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

GuildAutoCompleteInteraction

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

An AutoCompleteInteraction that took place in the context of a Guild.

Constructors

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

Properties

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

command

open val command: InteractionCommand

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

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.

focusedOption

open val focusedOption: StringOptionValue

The single focused option the user is currently typing.

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.

permissions

open val permissions: Permissions

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

supplier

open override val supplier: EntitySupplier

The supplier used to request entities.

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.

version

open val version: Int

read-only property, always 1

Functions

compareTo

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

Compares entities on id.

equals

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

getChannel

open suspend fun getChannel(): MessageChannel

getChannelOrNull

open suspend fun getChannelOrNull(): MessageChannel?

getGuild

open suspend fun getGuild(): Guild

getGuildOrNull

open suspend fun getGuildOrNull(): Guild?

hashCode

open override fun hashCode(): Int

suggest

suspend fun AutoCompleteInteractionBehavior.suggest(choices: List<Choice>)

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

suggestInteger

inline suspend fun AutoCompleteInteractionBehavior.suggestInteger(builder: IntegerOptionBuilder.() -> Unit)

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

suggestNumber

inline suspend fun AutoCompleteInteractionBehavior.suggestNumber(builder: NumberOptionBuilder.() -> Unit)

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

suggestString

inline suspend fun AutoCompleteInteractionBehavior.suggestString(builder: StringChoiceBuilder.() -> Unit)

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

toString

open override fun toString(): String

withStrategy

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

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