Skip to main content

DiscordInteraction

Documentation

Documentation / @discordeno/types / DiscordInteraction

Interface: DiscordInteraction

Defined in: discord/interactions.ts:18

https://docs.discord.com/developers/interactions/receiving-and-responding#interaction-object-interaction-structure

Properties​

app_permissions​

app_permissions: string

Defined in: discord/interactions.ts:57

Bitwise set of permissions the app has in the source location of the interaction

Remarks​

app_permissions includes ATTACH_FILES | EMBED_LINKS | MENTION_EVERYONE permissions for (G)DMs with other users, and additionally includes USE_EXTERNAL_EMOJIS for DMs with the app's bot user

application_id​

application_id: string

Defined in: discord/interactions.ts:22

Id of the application this interaction is for

attachment_size_limit​

attachment_size_limit: number

Defined in: discord/interactions.ts:69

Attachment size limit in bytes

authorizing_integration_owners​

authorizing_integration_owners: DiscordAuthorizingIntegrationOwners

Defined in: discord/interactions.ts:65

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

channel​

channel: Partial<DiscordChannel>

Defined in: discord/interactions.ts:35

The channel it was sent from

channel_id?​

optional channel_id?: string

Defined in: discord/interactions.ts:42

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: discord/interactions.ts:67

Context where the interaction was triggered from

data?​

optional data?: DiscordInteractionData

Defined in: discord/interactions.ts:29

The command data payload

Remarks​

This is always present on application command, message component, and modal submit interaction types. It is optional for future-proofing against new interaction types

entitlements​

entitlements: DiscordEntitlement[]

Defined in: discord/interactions.ts:63

For monetized apps, any entitlements for the invoking user, representing access to premium SKUs

guild?​

optional guild?: Partial<DiscordGuild>

Defined in: discord/interactions.ts:31

Guild that the interaction was sent from

guild_id?​

optional guild_id?: string

Defined in: discord/interactions.ts:33

The guild it was sent from

guild_locale?​

optional guild_locale?: string

Defined in: discord/interactions.ts:61

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

id​

id: string

Defined in: discord/interactions.ts:20

Id of the interaction

locale?​

optional locale?: string

Defined in: discord/interactions.ts:59

The selected language of the invoking user

member?​

optional member?: DiscordInteractionMember

Defined in: discord/interactions.ts:44

Guild member data for the invoking user, including permissions

message?​

optional message?: DiscordMessage

Defined in: discord/interactions.ts:52

For components or modals triggered by components, the message they were attached to

token​

token: string

Defined in: discord/interactions.ts:48

A continuation token for responding to the interaction

type​

type: InteractionTypes

Defined in: discord/interactions.ts:24

The type of interaction

user?​

optional user?: DiscordUser

Defined in: discord/interactions.ts:46

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

version​

version: 1

Defined in: discord/interactions.ts:50

Read-only property, always 1