AutocompleteInteraction

get channel(): Partial<APIAnnouncementThreadChannel> & Pick<APIChannel, "id" | "type"> | Partial<APIDMChannel> & Pick<APIChannel, "id" | "type"> | Partial<APIGroupDMChannel> & Pick<APIChannel, "id" | "type"> | Partial<APIGuildCategoryChannel> & Pick<APIChannel, "id" | "type"> | Partial<APIGuildForumChannel> & Pick<APIChannel, "id" | "type"> | Partial<APIGuildMediaChannel> & Pick<APIChannel, "id" | "type"> | Partial<APIGuildStageVoiceChannel> & Pick<APIChannel, "id" | "type"> | Partial<APIGuildVoiceChannel> & Pick<APIChannel, "id" | "type"> | Partial<APINewsChannel> & Pick<APIChannel, "id" | "type"> | Partial<APIPrivateThreadChannel> & Pick<APIChannel, "id" | "type"> | Partial<APIPublicThreadChannel> & Pick<APIChannel, "id" | "type"> | Partial<APITextChannel> & Pick<APIChannel, "id" | "type"> | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | never | undefined

Defined in: interactions/BaseInteraction.ts:129

The partial channel object the interaction was sent from, if any. Not cached — see Honocord’s runtime notes.

Returns

Inherited from

BaseInteraction.channel

channelId

Get Signature

get channelId(): string | undefined

Defined in: interactions/BaseInteraction.ts:124

The ID of the channel the interaction was sent from, if any.

Returns

string | undefined

Inherited from

BaseInteraction.channelId

commandId

Get Signature

get commandId(): string

Defined in: interactions/AutocompleteInteraction.ts:33

The invoked command’s ID.

Returns

string

commandName

Get Signature

get commandName(): string

Defined in: interactions/AutocompleteInteraction.ts:28

The invoked command’s name.

Returns

string

entitlements

Get Signature

get entitlements(): APIEntitlement[]

Defined in: interactions/BaseInteraction.ts:119

Entitlements for the invoking user, for monetized apps.

Returns

APIEntitlement[]

Inherited from

BaseInteraction.entitlements

guild

Get Signature

get guild(): APIPartialInteractionGuild | undefined

Defined in: interactions/BaseInteraction.ts:139

The partial guild object the interaction was sent from, if any. Not cached.

Returns

APIPartialInteractionGuild | undefined

Inherited from

BaseInteraction.guild

guildId

Get Signature

get guildId(): string | undefined

Defined in: interactions/BaseInteraction.ts:134

The ID of the guild the interaction was sent from, if any.

Returns

string | undefined

Inherited from

BaseInteraction.guildId

guildLocale

Get Signature

get guildLocale(): Locale | undefined

Defined in: interactions/BaseInteraction.ts:164

The guild’s locale, if sent from a guild.

Returns

Locale | undefined

Inherited from

BaseInteraction.guildLocale

id

Get Signature

get id(): string

Defined in: interactions/BaseInteraction.ts:174

The interaction’s ID.

Returns

string

Inherited from

BaseInteraction.id

locale

Get Signature

get locale(): Locale | undefined

Defined in: interactions/BaseInteraction.ts:159

The invoking user’s locale.

Returns

Locale | undefined

Inherited from

BaseInteraction.locale

member

Get Signature

get member(): APIInteractionGuildMember | undefined

Defined in: interactions/BaseInteraction.ts:154

The guild member who triggered the interaction, if sent from a guild.

Returns

APIInteractionGuildMember | undefined

Inherited from

BaseInteraction.member

token

Get Signature

get token(): string

Defined in: interactions/BaseInteraction.ts:169

The interaction token, used to send/edit/delete responses.

Returns

string

Inherited from

BaseInteraction.token

user

Get Signature

get user(): APIUser

Defined in: interactions/BaseInteraction.ts:149

The user who triggered the interaction (resolved from member.user in guilds, user in DMs).

Returns

APIUser

Inherited from

BaseInteraction.user

userId

Get Signature

get userId(): string | undefined

Defined in: interactions/BaseInteraction.ts:144

The ID of the user who triggered the interaction.

Returns

string | undefined

Inherited from

BaseInteraction.userId

version

Get Signature

get version(): 1

Defined in: interactions/BaseInteraction.ts:184

Discord’s interaction payload version (always 1).

Returns

1

Inherited from

BaseInteraction.version

Methods

deferReply()

deferReply(forceEphemeral?): Promise<RESTPostAPIInteractionCallbackWithResponseResult>

Defined in: interactions/BaseInteraction.ts:296

Acknowledges the interaction without sending an initial response, showing a “thinking” state. Use editReply afterwards to send the actual response, within the 15-minute interaction token lifetime.

Parameters

forceEphemeral?

boolean = true

Whether the eventual response should be ephemeral. Defaults to true.

Returns

Promise<RESTPostAPIInteractionCallbackWithResponseResult>

Inherited from

BaseInteraction.deferReply

deferUpdate()

deferUpdate(): Promise<RESTPostAPIInteractionCallbackWithResponseResult>

Defined in: interactions/BaseInteraction.ts:321

Defers the update of a component interaction.

Returns

Promise<RESTPostAPIInteractionCallbackWithResponseResult>

A promise that resolves when the update is deferred

Responding to a component interaction via the deferUpdate() method acknowledges the interaction and resets the message state. This method can be used to suppress the need for further responses, however it’s encouraged to provide meaningful feedback to users via an update() or ephemeral reply() at least.
Once deferUpdate() has been called, future messages can be sent by calling followUp() or edits can be made by calling editReply() on the component interaction.

Example flow:

User clicks a button.
Bot calls deferUpdate() to acknowledge the interaction.
Bot performs some processing.
Bot calls editReply() to update the original message.

Inherited from

BaseInteraction.deferUpdate

deleteReply()

deleteReply(messageId?): Promise<void>

Defined in: interactions/BaseInteraction.ts:359

Deletes the original interaction response (or a follow-up message).

Parameters

messageId?

string

The message id to delete, defaults to @original

Returns

Promise<void>

A promise that resolves when the message is deleted

This is used to delete the original interaction response message or a follow-up message.

Inherited from

BaseInteraction.deleteReply

editReply()

editReply(options, messageId?): Promise<APIMessage>

Defined in: interactions/BaseInteraction.ts:336

Edits the original interaction response.

Parameters

options

string | InteractionResponseCallbackData

The options to edit the message with

messageId?

string = "@original"

The message id to edit, defaults to @original

Returns

Promise<APIMessage>

The edited message

This is used to edit the original interaction response message.

Before using this method, the interaction needs to be replied to first before using this method - with reply, deferReply or update.

Inherited from

BaseInteraction.editReply

followUp()

followUp(options, forceEphemeral?): Promise<APIMessage>

Defined in: interactions/BaseInteraction.ts:397

Sends a follow-up message to the interaction.

Parameters

options

string | InteractionResponseCallbackData

The options to send the follow-up message with

forceEphemeral?

boolean = false

Whether to force the message to be ephemeral

Returns

Promise<APIMessage>

The sent follow-up message

This is used to send additional messages after the initial interaction response.

Inherited from

BaseInteraction.followUp

getAppEntitlements()

getAppEntitlements(): APIEntitlement[]

Defined in: interactions/BaseInteraction.ts:207

Returns entitlements belonging to this interaction’s application.

Returns

APIEntitlement[]

Inherited from

BaseInteraction.getAppEntitlements

guildHavePremium()

guildHavePremium(): boolean

Defined in: interactions/BaseInteraction.ts:212

Whether the guild this interaction was sent from currently has an active, non-expired entitlement.

Returns

boolean

Inherited from

BaseInteraction.guildHavePremium

inDM()

inDM(): this is BaseInteraction<ApplicationCommandAutocomplete, BaseInteractionContext> & { guild: undefined; guild_id: undefined; guild_locale: undefined }

Defined in: interactions/BaseInteraction.ts:202

Type guard narrowing guild_id/guild/guild_locale to undefined when the interaction was sent from a DM.

Returns

this is BaseInteraction<ApplicationCommandAutocomplete, BaseInteractionContext> & { guild: undefined; guild_id: undefined; guild_locale: undefined }

Inherited from

BaseInteraction.inDM

inGuild()

inGuild(): this is BaseInteraction<ApplicationCommandAutocomplete, BaseInteractionContext> & { guild: APIPartialInteractionGuild; guild_id: string; guild_locale: Locale }

Defined in: interactions/BaseInteraction.ts:197

Type guard narrowing guild_id/guild/guild_locale to defined when the interaction was sent from a guild.

Returns

this is BaseInteraction<ApplicationCommandAutocomplete, BaseInteractionContext> & { guild: APIPartialInteractionGuild; guild_id: string; guild_locale: Locale }

Inherited from

BaseInteraction.inGuild

isAutocomplete()

isAutocomplete(): this is AutocompleteInteraction<Context> & { type: ApplicationCommandAutocomplete }

Defined in: interactions/BaseInteraction.ts:490

Type guard: whether this is an autocomplete request for a slash command option.

Returns

this is AutocompleteInteraction<Context> & { type: ApplicationCommandAutocomplete }

Inherited from

BaseInteraction.isAutocomplete

isButton()

isButton(): this is ButtonInteraction<Context>

Defined in: interactions/BaseInteraction.ts:460

Type guard: whether this is a button click interaction.

Returns

this is ButtonInteraction<Context>

Inherited from

BaseInteraction.isButton

isChannelSelect()

isChannelSelect(): this is ChannelSelectInteraction<Context>

Defined in: interactions/BaseInteraction.ts:485

Type guard: whether this is a channel select menu interaction.

Returns

this is ChannelSelectInteraction<Context>

Inherited from

BaseInteraction.isChannelSelect

isChatInputCommand()

isChatInputCommand(): this is ChatInputCommandInteraction<Context>

Defined in: interactions/BaseInteraction.ts:421

Type guard: whether this is a chat input (slash) command interaction.

Returns

this is ChatInputCommandInteraction<Context>

Inherited from

BaseInteraction.isChatInputCommand

isCommand()

isCommand(): this is CommandInteraction<ApplicationCommandType, Context>

Defined in: interactions/BaseInteraction.ts:416

Type guard: whether this is an application command interaction (slash command or context menu command).

Returns

this is CommandInteraction<ApplicationCommandType, Context>

Inherited from

BaseInteraction.isCommand

isJSONEncodable()

protected isJSONEncodable(obj): obj is JSONEncodable<unknown>

Defined in: interactions/BaseInteraction.ts:188

Parameters

obj

unknown

Returns

obj is JSONEncodable<unknown>

Inherited from

BaseInteraction.isJSONEncodable

isMentionableSelect()

isMentionableSelect(): this is MentionableSelectInteraction<Context>

Defined in: interactions/BaseInteraction.ts:480

Type guard: whether this is a mentionable (user + role) select menu interaction.

Returns

this is MentionableSelectInteraction<Context>

Inherited from

BaseInteraction.isMentionableSelect

isMessageComponent()

isMessageComponent(): this is MessageComponentInteraction<Context, MessageComponentType>

Defined in: interactions/BaseInteraction.ts:455

Type guard: whether this is a message component interaction (button or select menu).

Returns

this is MessageComponentInteraction<Context, MessageComponentType>

Inherited from

BaseInteraction.isMessageComponent

isMessageContextCommand()

isMessageContextCommand(): this is MessageContextInteraction<Context>

Defined in: interactions/BaseInteraction.ts:437

Type guard: whether this is a message context menu command interaction.

Returns

this is MessageContextInteraction<Context>

Inherited from

BaseInteraction.isMessageContextCommand

isMessageModal()

isMessageModal(): this is ModalInteraction<Context & { message: APIMessage }>

Defined in: interactions/BaseInteraction.ts:450

Type guard: whether this is a modal submit interaction that opened from a message (not a slash command).

Returns

this is ModalInteraction<Context & { message: APIMessage }>

Inherited from

BaseInteraction.isMessageModal

isModal()

isModal(): this is ModalInteraction<BaseInteractionContext>

Defined in: interactions/BaseInteraction.ts:445

Type guard: whether this is a modal submit interaction.

Returns

this is ModalInteraction<BaseInteractionContext>

Inherited from

BaseInteraction.isModal

isRoleSelect()

isRoleSelect(): this is RoleSelectInteraction<Context>

Defined in: interactions/BaseInteraction.ts:475

Type guard: whether this is a role select menu interaction.

Returns

this is RoleSelectInteraction<Context>

Inherited from

BaseInteraction.isRoleSelect

isStringSelect()

isStringSelect(): this is StringSelectInteraction<Context>

Defined in: interactions/BaseInteraction.ts:465

Type guard: whether this is a string select menu interaction.

Returns

this is StringSelectInteraction<Context>

Inherited from

BaseInteraction.isStringSelect

isUserContextCommand()

isUserContextCommand(): this is UserContextInteraction<Context>

Defined in: interactions/BaseInteraction.ts:429

Type guard: whether this is a user context menu command interaction.

Returns

this is UserContextInteraction<Context>

Inherited from

BaseInteraction.isUserContextCommand

isUserSelect()

isUserSelect(): this is UserSelectInteraction<Context>

Defined in: interactions/BaseInteraction.ts:470

Type guard: whether this is a user select menu interaction.

Returns

this is UserSelectInteraction<Context>

Inherited from

BaseInteraction.isUserSelect

reply()

reply(options, forceEphemeral?): Promise<RESTPostAPIInteractionCallbackWithResponseResult>

Defined in: interactions/BaseInteraction.ts:273

Sends the initial response to the interaction.

Parameters

options

string | InteractionResponseCallbackData

The message content, or a string shorthand for { content: options }

forceEphemeral?

boolean = true

Whether to force the response to be ephemeral (visible only to the invoking user). Defaults to true.

Returns

Promise<RESTPostAPIInteractionCallbackWithResponseResult>

The created interaction response, including the created message.

Inherited from

BaseInteraction.reply

respond()

respond(choices): Promise<void>

Defined in: interactions/AutocompleteInteraction.ts:42

Sends autocomplete choices back to Discord.

Parameters

choices

APIApplicationCommandOptionChoice<string | number>[]

Up to 25 choices to display to the user.

Returns

Promise<void>

toSnakeCase()

protected toSnakeCase<T>(obj): T

Defined in: interactions/BaseInteraction.ts:192

Type Parameters

T

T = unknown

Parameters

obj

unknown

Returns

T

Inherited from

BaseInteraction.toSnakeCase

update()

update(options): Promise<RESTPostAPIInteractionCallbackWithResponseResult>

Defined in: interactions/BaseInteraction.ts:374

Updates the original interaction response.

Parameters

options

string | InteractionResponseCallbackData

The options to update the message with

Returns

Promise<RESTPostAPIInteractionCallbackWithResponseResult>

The updated message

This is mainly used for component interactions where you want to update the message the component is attached to OR for moodal submit interactions to update the message that opened the modal.

After calling this method, the interaction is considered replied and you need to use editReply to edit the original response.

Inherited from

BaseInteraction.update

userHavePremium()

userHavePremium(): boolean

Defined in: interactions/BaseInteraction.ts:222

Whether the user who triggered this interaction currently has an active, non-expired entitlement.

Returns

boolean

Inherited from

BaseInteraction.userHavePremium