Skip to content

Interaction

Extended by

Type Parameters

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

Properties

client

readonly client: Client<Transformers, CacheManagerStructure>

Defined in

transformers/src/factories/interaction.ts:77


id

readonly id: string

Defined in

transformers/src/factories/interaction.ts:78


applicationId

readonly applicationId: string

Defined in

transformers/src/factories/interaction.ts:79


type

readonly type: InteractionType

Defined in

transformers/src/factories/interaction.ts:80


token

readonly token: string

Defined in

transformers/src/factories/interaction.ts:81


version

readonly version: 1 = 1

Defined in

transformers/src/factories/interaction.ts:82


appPermissions

readonly appPermissions: string

Defined in

transformers/src/factories/interaction.ts:83


locale

readonly locale: undefined | Locale

This is only undefined if type is PING

Defined in

transformers/src/factories/interaction.ts:85


entitlements

readonly entitlements: EntitlementStructure[]

Defined in

transformers/src/factories/interaction.ts:86


authorizingIntegrationOwners

readonly authorizingIntegrationOwners: IntegrationTypeMap

Defined in

transformers/src/factories/interaction.ts:87


context

readonly context: undefined | InteractionContextType

Defined in

transformers/src/factories/interaction.ts:88


data

readonly data: T

Defined in

transformers/src/factories/interaction.ts:89


message

readonly message: M

Defined in

transformers/src/factories/interaction.ts:90

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:113

reply(options)

reply(options): Promise<void>

Parameters
ParameterType
optionsInteractionReplyOptions
Returns

Promise<void>

Defined in

transformers/src/factories/interaction.ts:114


deferReply()

deferReply(ephemeral): Promise<void>

Parameters

ParameterTypeDefault value
ephemeralbooleanfalse

Returns

Promise<void>

Defined in

transformers/src/factories/interaction.ts:160


deferComponentReply()

deferComponentReply(ephemeral): Promise<void>

Parameters

ParameterTypeDefault value
ephemeralbooleanfalse

Returns

Promise<void>

Defined in

transformers/src/factories/interaction.ts:169


updateComponents()

updateComponents(content, options)

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

Parameters
ParameterType
contentstring
options?InteractionReplyOptions
Returns

Promise<void>

Defined in

transformers/src/factories/interaction.ts:178

updateComponents(options)

updateComponents(options): Promise<void>

Parameters
ParameterType
optionsInteractionReplyOptions
Returns

Promise<void>

Defined in

transformers/src/factories/interaction.ts:179


showChoices()

showChoices(choices): Promise<void>

Parameters

ParameterType
choicesChoiceStructure[]

Returns

Promise<void>

Defined in

transformers/src/factories/interaction.ts:225


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:232

showModal(options)

showModal(options): Promise<void>

Parameters
ParameterType
optionsInteractionShowModalOptions
Returns

Promise<void>

Defined in

transformers/src/factories/interaction.ts:233


followUp()

followUp(content, options)

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

Parameters
ParameterType
contentstring
options?InteractionReplyOptions
Returns

Promise<Message>

Defined in

transformers/src/factories/interaction.ts:258

followUp(options)

followUp(options): Promise<Message>

Parameters
ParameterType
optionsInteractionReplyOptions
Returns

Promise<Message>

Defined in

transformers/src/factories/interaction.ts:259


editReply()

editReply(content, options)

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

Parameters
ParameterType
contentstring
options?InteractionEditOptions
Returns

Promise<Message>

Defined in

transformers/src/factories/interaction.ts:302

editReply(options)

editReply(options): Promise<Message>

Parameters
ParameterType
optionsInteractionEditOptions
Returns

Promise<Message>

Defined in

transformers/src/factories/interaction.ts:303


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:327

editFollowUp(messageId, options)

editFollowUp(messageId, options): Promise<Message>

Parameters
ParameterType
messageIdstring
optionsInteractionEditOptions
Returns

Promise<Message>

Defined in

transformers/src/factories/interaction.ts:328


deleteReply()

deleteReply(): Promise<void>

Returns

Promise<void>

Defined in

transformers/src/factories/interaction.ts:352


deleteFollowUp()

deleteFollowUp(messageId): Promise<void>

Parameters

ParameterType
messageIdstring

Returns

Promise<void>

Defined in

transformers/src/factories/interaction.ts:356


fetchOriginalReply()

fetchOriginalReply(): Promise<Structure>

Returns

Promise<Structure>

Defined in

transformers/src/factories/interaction.ts:360


isPingInteraction()

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

Returns

this is Interaction<undefined, undefined | Message>

Defined in

transformers/src/factories/interaction.ts:364


isApplicationCommandInteraction()

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

Returns

this is Interaction<ApplicationCommandData<undefined>, undefined>

Defined in

transformers/src/factories/interaction.ts:368


isAutocompleteInteraction()

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

Returns

this is Interaction<AutocompleteData, undefined>

Defined in

transformers/src/factories/interaction.ts:372


isMessageComponentInteraction()

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

Returns

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

Defined in

transformers/src/factories/interaction.ts:376


isModalSubmitInteraction()

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

Returns

this is Interaction<ModalSubmitData, undefined>

Defined in

transformers/src/factories/interaction.ts:380


inGuild()

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

Returns

this is GuildInteraction<T, M>

Defined in

transformers/src/factories/interaction.ts:384


inDM()

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

Returns

this is DMInteraction<T, M>

Defined in

transformers/src/factories/interaction.ts:388