Interaction

@discordeno/bot

---

Documentation / @discordeno/bot / Interaction

Interface: Interaction

Defined in: packages/bot/src/transformers/types.ts:825

Properties

acknowledged

acknowledged: boolean

Defined in: packages/bot/src/transformers/types.ts:829

Whether or not this interaction has been responded to.

---

applicationId

applicationId: bigint

Defined in: packages/bot/src/transformers/types.ts:833

Id of the application this interaction is for

---

appPermissions

appPermissions: bigint

Defined in: packages/bot/src/transformers/types.ts:865

The computed permissions for a bot or app in the context of a specific interaction (including channel overwrites)

---

authorizingIntegrationOwners

authorizingIntegrationOwners: Partial<Record<DiscordApplicationIntegrationType, bigint>>

Defined in: packages/bot/src/transformers/types.ts:867

Mapping of installation contexts that the interaction was authorized for to related user or guild IDs.

---

bot

bot: Bot

Defined in: packages/bot/src/transformers/types.ts:827

The bot object

---

channel

channel: Partial<Channel>

Defined in: packages/bot/src/transformers/types.ts:841

The channel it was sent from

---

channelId?

optional channelId: bigint

Defined in: packages/bot/src/transformers/types.ts:848

The ID of channel it was sent from

Remarks

It is recommended that you begin using this channel field to identify the source channel of the interaction as they may deprecate the existing channel_id field in the future.

---

context?

optional context: DiscordInteractionContextType

Defined in: packages/bot/src/transformers/types.ts:869

Context where the interaction was triggered from

---

data?

optional data: InteractionData

Defined in: packages/bot/src/transformers/types.ts:860

the command data payload

---

defer()

defer: (isPrivate?, options?) => Promise<void | InteractionCallbackResponse>

Defined in: packages/bot/src/transformers/types.ts:906

Defer the interaction for updating the response at a later time with edit.

Parameters

isPrivate?

boolean

options?

InteractionCallbackOptions

Returns

Promise<void | InteractionCallbackResponse>

Remarks

This will send a DeferredChannelMessageWithSource response.

---

deferEdit()

deferEdit: (options?) => Promise<void | InteractionCallbackResponse>

Defined in: packages/bot/src/transformers/types.ts:899

Defer the interaction for updating the referenced message at a later time with edit.

Parameters

options?

InteractionCallbackOptions

Returns

Promise<void | InteractionCallbackResponse>

Remarks

This will send a DeferredUpdateMessage response.

---

delete()

delete: (messageId?) => Promise<void>

Defined in: packages/bot/src/transformers/types.ts:908

Delete the original interaction response or a followup if the message id is provided.

Parameters

messageId?

BigString

Returns

Promise<void>

---

edit()

edit: (response, messageId?, options?) => Promise<void | InteractionCallbackResponse | Message>

Defined in: packages/bot/src/transformers/types.ts:888

Edit the original response of an interaction or a followup if the message id is provided.

Parameters

response

string | InteractionCallbackData

messageId?

BigString

options?

InteractionCallbackOptions

Returns

Promise<void | InteractionCallbackResponse | Message>

Remarks

This will edit the original interaction response or, if the interaction has not yet been acknowledged and the type of the interaction is MessageComponent it will instead send a UpdateMessage response instead.

---

guild

guild: Guild

Defined in: packages/bot/src/transformers/types.ts:837

Guild that the interaction was sent from

---

guildId?

optional guildId: bigint

Defined in: packages/bot/src/transformers/types.ts:839

The guild it was sent from

---

guildLocale?

optional guildLocale: string

Defined in: packages/bot/src/transformers/types.ts:863

The guild's preferred locale, if invoked in a guild

---

id

id: bigint

Defined in: packages/bot/src/transformers/types.ts:831

Id of the interaction

---

locale?

optional locale: string

Defined in: packages/bot/src/transformers/types.ts:861

---

member?

optional member: Member

Defined in: packages/bot/src/transformers/types.ts:850

Guild member data for the invoking user, including permissions

---

message?

optional message: Message

Defined in: packages/bot/src/transformers/types.ts:858

For the message the button was attached to

---

respond()

respond: (response, options?) => Promise<void | InteractionCallbackResponse | Message>

Defined in: packages/bot/src/transformers/types.ts:878

Sends a response to an interaction.

Parameters

response

string | InteractionCallbackData

options?

isPrivate

boolean

withResponse

boolean

Returns

Promise<void | InteractionCallbackResponse | Message>

Remarks

This will send a ChannelMessageWithSource, ApplicationCommandAutocompleteResult or Modal response based on the type of the interaction you are responding to.

If the interaction has been already acknowledged, indicated by Interaction.acknowledged, it will send a followup message instead.

---

token

token: string

Defined in: packages/bot/src/transformers/types.ts:854

A continuation token for responding to the interaction

---

type

type: InteractionTypes

Defined in: packages/bot/src/transformers/types.ts:835

The type of interaction

---

user

user: User

Defined in: packages/bot/src/transformers/types.ts:852

User object for the invoking user, if invoked in a DM

---

version

version: 1

Defined in: packages/bot/src/transformers/types.ts:856

Read-only property, always 1