Skip to content

Interaction

Extended by

Type Parameters

Type ParameterDefault type
T extends InteractionDataInteractionData
M extends undefined | Messageundefined | Message

Properties

client

readonly client: Client

Defined in

transformers/src/factories/interaction.ts:78


id

readonly id: string

Defined in

transformers/src/factories/interaction.ts:79


applicationId

readonly applicationId: string

Defined in

transformers/src/factories/interaction.ts:80


type

readonly type: InteractionType

Defined in

transformers/src/factories/interaction.ts:81


token

readonly token: string

Defined in

transformers/src/factories/interaction.ts:82


version

readonly version: 1 = 1

Defined in

transformers/src/factories/interaction.ts:83


appPermissions

readonly appPermissions: string

Defined in

transformers/src/factories/interaction.ts:84


locale

readonly locale: undefined | Locale

This is only undefined if type is PING

Defined in

transformers/src/factories/interaction.ts:86


entitlements

readonly entitlements: EntitlementStructure[]

Defined in

transformers/src/factories/interaction.ts:87


authorizingIntegrationOwners

readonly authorizingIntegrationOwners: IntegrationTypeMap

Defined in

transformers/src/factories/interaction.ts:88


context

readonly context: undefined | InteractionContextType

Defined in

transformers/src/factories/interaction.ts:89


data

readonly data: T

Defined in

transformers/src/factories/interaction.ts:90


message

readonly message: M

Defined in

transformers/src/factories/interaction.ts:91

Methods

reply()

reply(content, options)

reply(content, options?): Promise<void>

Parameters
ParameterType
contentstring
options?InteractionReplyOptions
Returns

Promise<void>

Defined in

transformers/src/factories/interaction.ts:114

reply(options)

reply(options): Promise<void>

Parameters
ParameterType
optionsInteractionReplyOptions
Returns

Promise<void>

Defined in

transformers/src/factories/interaction.ts:115


deferReply()

deferReply(ephemeral): Promise<void>

Parameters

ParameterTypeDefault value
ephemeralbooleanfalse

Returns

Promise<void>

Defined in

transformers/src/factories/interaction.ts:163


deferComponentReply()

deferComponentReply(ephemeral): Promise<void>

Parameters

ParameterTypeDefault value
ephemeralbooleanfalse

Returns

Promise<void>

Defined in

transformers/src/factories/interaction.ts:172


updateComponents()

updateComponents(content, options)

updateComponents(content, options?): Promise<void>

Parameters
ParameterType
contentstring
options?InteractionReplyOptions
Returns

Promise<void>

Defined in

transformers/src/factories/interaction.ts:181

updateComponents(options)

updateComponents(options): Promise<void>

Parameters
ParameterType
optionsInteractionReplyOptions
Returns

Promise<void>

Defined in

transformers/src/factories/interaction.ts:182


showChoices()

showChoices(choices): Promise<void>

Parameters

ParameterType
choicesChoiceStructure[]

Returns

Promise<void>

Defined in

transformers/src/factories/interaction.ts:230


showModal()

showModal(title, id, components)

showModal(title, id, components): Promise<void>

Parameters
ParameterType
titlestring
idstring
componentsActionRowStructure[]
Returns

Promise<void>

Defined in

transformers/src/factories/interaction.ts:237

showModal(options)

showModal(options): Promise<void>

Parameters
ParameterType
optionsInteractionShowModalOptions
Returns

Promise<void>

Defined in

transformers/src/factories/interaction.ts:238


followUp()

followUp(content, options)

followUp(content, options?): Promise<Message>

Parameters
ParameterType
contentstring
options?InteractionReplyOptions
Returns

Promise<Message>

Defined in

transformers/src/factories/interaction.ts:263

followUp(options)

followUp(options): Promise<Message>

Parameters
ParameterType
optionsInteractionReplyOptions
Returns

Promise<Message>

Defined in

transformers/src/factories/interaction.ts:264


editReply()

editReply(content, options)

editReply(content, options?): Promise<Message>

Parameters
ParameterType
contentstring
options?InteractionEditOptions
Returns

Promise<Message>

Defined in

transformers/src/factories/interaction.ts:309

editReply(options)

editReply(options): Promise<Message>

Parameters
ParameterType
optionsInteractionEditOptions
Returns

Promise<Message>

Defined in

transformers/src/factories/interaction.ts:310


editFollowUp()

editFollowUp(messageId, content, options)

editFollowUp(messageId, content, options?): Promise<Message>

Parameters
ParameterType
messageIdstring
contentstring
options?InteractionEditOptions
Returns

Promise<Message>

Defined in

transformers/src/factories/interaction.ts:334

editFollowUp(messageId, options)

editFollowUp(messageId, options): Promise<Message>

Parameters
ParameterType
messageIdstring
optionsInteractionEditOptions
Returns

Promise<Message>

Defined in

transformers/src/factories/interaction.ts:335


deleteReply()

deleteReply(): Promise<void>

Returns

Promise<void>

Defined in

transformers/src/factories/interaction.ts:359


deleteFollowUp()

deleteFollowUp(messageId): Promise<void>

Parameters

ParameterType
messageIdstring

Returns

Promise<void>

Defined in

transformers/src/factories/interaction.ts:363


fetchOriginalReply()

fetchOriginalReply(): Promise<Structure>

Returns

Promise<Structure>

Defined in

transformers/src/factories/interaction.ts:367


isPingInteraction()

isPingInteraction(): this is Interaction<undefined, undefined | Message>

Returns

this is Interaction<undefined, undefined | Message>

Defined in

transformers/src/factories/interaction.ts:371


isApplicationCommandInteraction()

isApplicationCommandInteraction(): this is Interaction<ApplicationCommandData<undefined>, undefined>

Returns

this is Interaction<ApplicationCommandData<undefined>, undefined>

Defined in

transformers/src/factories/interaction.ts:375


isAutocompleteInteraction()

isAutocompleteInteraction(): this is Interaction<AutocompleteData, undefined>

Returns

this is Interaction<AutocompleteData, undefined>

Defined in

transformers/src/factories/interaction.ts:379


isMessageComponentInteraction()

isMessageComponentInteraction(): this is Interaction<MessageComponentData<undefined | string[]>, Message>

Returns

this is Interaction<MessageComponentData<undefined | string[]>, Message>

Defined in

transformers/src/factories/interaction.ts:383


isModalSubmitInteraction()

isModalSubmitInteraction(): this is Interaction<ModalSubmitData, undefined>

Returns

this is Interaction<ModalSubmitData, undefined>

Defined in

transformers/src/factories/interaction.ts:387


inGuild()

inGuild(): this is GuildInteraction<T, M>

Returns

this is GuildInteraction<T, M>

Defined in

transformers/src/factories/interaction.ts:391


inDM()

inDM(): this is DMInteraction<T, M>

Returns

this is DMInteraction<T, M>

Defined in

transformers/src/factories/interaction.ts:395