class AutocompleteInteraction

extends

BaseInteraction<Cached>
export class AutocompleteInteraction<Cached extends CacheType = CacheType> extends BaseInteraction<Cached>

Represents an autocomplete interaction.

Type Parameters

optional
Cached? extends CacheType = CacheType

applicationId : Snowflake

The application's id

Inherited from: BaseInteraction

appPermissions : Readonly<PermissionsBitField>

Set of permissions the application or bot has within the channel the interaction was sent from

Inherited from: BaseInteraction

authorizingIntegrationOwners : APIAuthorizingIntegrationOwnersMap

Mapping of installation contexts that the interaction was authorized for the related user or guild ids

Inherited from: BaseInteraction

See also: https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-authorizing-integration-owners-object

readonly
channel : CacheTypeReducer<Cached, GuildTextBasedChannel | null, GuildTextBasedChannel | null, GuildTextBasedChannel | null, TextBasedChannel | null>

The channel this interaction was sent in

Inherited from: BaseInteraction

channelId : Snowflake

The id of the channel this interaction was sent in

readonly
client : Client<true>

The client that instantiated this

Inherited from: Base

readonly
command : ApplicationCommand | ApplicationCommand<{ guild: GuildResolvable }> | null

The invoked application command, if it was fetched before

commandGuildId : Snowflake | null

The id of the guild the invoked application command is registered to

commandId : Snowflake

The invoked application command's id

commandName : string

The invoked application command's name

commandType : ApplicationCommandType.ChatInput

The invoked application command's type

context : InteractionContextType | null

Context where the interaction was triggered from

Inherited from: BaseInteraction

readonly
createdAt : Date

The time the interaction was created at

Inherited from: BaseInteraction

readonly
createdTimestamp : number

The timestamp the interaction was created at

Inherited from: BaseInteraction

entitlements : Collection<Snowflake, Entitlement>

The entitlements for the invoking user, representing access to premium SKUs

Inherited from: BaseInteraction

readonly
guild : CacheTypeReducer<Cached, Guild, null>

The guild this interaction was sent in

Inherited from: BaseInteraction

guildId : CacheTypeReducer<Cached, Snowflake>

The id of the guild this interaction was sent in

Inherited from: BaseInteraction

guildLocale : CacheTypeReducer<Cached, Locale>

The preferred locale from the guild this interaction was sent in

Inherited from: BaseInteraction

id : Snowflake

The interaction's id

Inherited from: BaseInteraction

locale : Locale

The locale of the user who invoked this interaction

Inherited from: BaseInteraction

member : CacheTypeReducer<Cached, GuildMember, APIInteractionGuildMember>

If this interaction was sent in a guild, the member which sent it

Inherited from: BaseInteraction

memberPermissions : CacheTypeReducer<Cached, Readonly<PermissionsBitField>>

The permissions of the member, if one exists, in the channel this interaction was executed in

Inherited from: BaseInteraction

options : Omit<CommandInteractionOptionResolver<Cached>, 'getMessage' | 'getUser' | 'getAttachment' | 'getChannel' | 'getMember' | 'getMentionable' | 'getRole'>

The options passed to the command

responded : boolean

Whether this interaction has already received a response

readonly
token : string

The interaction's token

Inherited from: BaseInteraction

type : InteractionType.ApplicationCommandAutocomplete

The interaction's type

user : User

The user who created this interaction

Inherited from: BaseInteraction

version : number

The version

Inherited from: BaseInteraction

inCachedGuild() : this is AutocompleteInteraction<'cached'>

Indicates whether this interaction is received from a cached guild.

inGuild() : this is AutocompleteInteraction<'raw' | 'cached'>

Indicates whether this interaction is received from a guild.

inRawGuild() : this is AutocompleteInteraction<'raw'>

Indicates whether or not this interaction is received from an uncached guild.

isAnySelectMenu() : this is AnySelectMenuInteraction<Cached>

Indicates whether this interaction is a select menu of any known type.

Inherited from: BaseInteraction

isAutocomplete() : this is AutocompleteInteraction<Cached>

Indicates whether this interaction is an AutocompleteInteraction

Inherited from: BaseInteraction

isButton() : this is ButtonInteraction<Cached>

Indicates whether this interaction is a ButtonInteraction.

Inherited from: BaseInteraction

isChannelSelectMenu() : this is ChannelSelectMenuInteraction<Cached>

Indicates whether this interaction is a ChannelSelectMenuInteraction

Inherited from: BaseInteraction

isChatInputCommand() : this is ChatInputCommandInteraction<Cached>

Indicates whether this interaction is a ChatInputCommandInteraction.

Inherited from: BaseInteraction

isCommand() : this is CommandInteraction<Cached>

Indicates whether this interaction is a CommandInteraction

Inherited from: BaseInteraction

isContextMenuCommand() : this is ContextMenuCommandInteraction<Cached>

Indicates whether this interaction is a ContextMenuCommandInteraction

Inherited from: BaseInteraction

isMentionableSelectMenu() : this is MentionableSelectMenuInteraction<Cached>

Indicates whether this interaction is a MentionableSelectMenuInteraction

Inherited from: BaseInteraction

isMessageComponent() : this is MessageComponentInteraction<Cached>

Indicates whether this interaction is a MessageComponentInteraction

Inherited from: BaseInteraction

isMessageContextMenuCommand() : this is MessageContextMenuCommandInteraction<Cached>

Indicates whether this interaction is a MessageContextMenuCommandInteraction

Inherited from: BaseInteraction

isModalSubmit() : this is ModalSubmitInteraction<Cached>

Indicates whether this interaction is a ModalSubmitInteraction

Inherited from: BaseInteraction

isRepliable() : this is RepliableInteraction<Cached>

Indicates whether this interaction can be replied to.

Inherited from: BaseInteraction

isRoleSelectMenu() : this is RoleSelectMenuInteraction<Cached>

Indicates whether this interaction is a RoleSelectMenuInteraction

Inherited from: BaseInteraction

deprecated
isSelectMenu() : this is StringSelectMenuInteraction<Cached>

Indicates whether this interaction is a StringSelectMenuInteraction.

Inherited from: BaseInteraction

isStringSelectMenu() : this is StringSelectMenuInteraction<Cached>

Indicates whether this interaction is a StringSelectMenuInteraction.

Inherited from: BaseInteraction

isUserContextMenuCommand() : this is UserContextMenuCommandInteraction<Cached>

Indicates whether this interaction is a UserContextMenuCommandInteraction

Inherited from: BaseInteraction

isUserSelectMenu() : this is UserSelectMenuInteraction<Cached>

Indicates whether this interaction is a UserSelectMenuInteraction

Inherited from: BaseInteraction

respond(
options: readonly ApplicationCommandOptionChoiceData[]
) : Promise<void>

Sends results for the autocomplete of this interaction.

Examples:
// respond to autocomplete interaction
interaction.respond([
 {
   name: 'Option 1',
   value: 'option1',
 },
])
 .then(() => console.log('Successfully responded to the autocomplete interaction'))
 .catch(console.error);

toJSON(
...props: Record<string, boolean | string>[]
) : unknown

Inherited from: Base

valueOf() : string

Inherited from: Base