Skip to content

GuildInteraction

Extends

Type Parameters

Type ParameterDefault type
T extends InteractionData-
M extends undefined | Messageundefined | Message

Constructors

new GuildInteraction()

new GuildInteraction<T, M>(client, interaction, isDM, data?): GuildInteraction<T, M>

Parameters

ParameterType
clientClient<Transformers, CacheManagerStructure>
interactionGuildStructure
isDMboolean
data?T

Returns

GuildInteraction<T, M>

Inherited from

Interaction<T, M>.constructor

Defined in

transformers/src/factories/interaction.ts:413

Properties

client

readonly client: Client<Transformers, CacheManagerStructure>

Inherited from

Interaction.client

Defined in

transformers/src/factories/interaction.ts:77


id

readonly id: string

Inherited from

Interaction.id

Defined in

transformers/src/factories/interaction.ts:78


applicationId

readonly applicationId: string

Inherited from

Interaction.applicationId

Defined in

transformers/src/factories/interaction.ts:79


type

readonly type: InteractionType

Inherited from

Interaction.type

Defined in

transformers/src/factories/interaction.ts:80


token

readonly token: string

Inherited from

Interaction.token

Defined in

transformers/src/factories/interaction.ts:81


version

readonly version: 1 = 1

Inherited from

Interaction.version

Defined in

transformers/src/factories/interaction.ts:82


appPermissions

readonly appPermissions: string

Inherited from

Interaction.appPermissions

Defined in

transformers/src/factories/interaction.ts:83


locale

readonly locale: undefined | Locale

This is only undefined if type is PING

Inherited from

Interaction.locale

Defined in

transformers/src/factories/interaction.ts:85


entitlements

readonly entitlements: EntitlementStructure[]

Inherited from

Interaction.entitlements

Defined in

transformers/src/factories/interaction.ts:86


authorizingIntegrationOwners

readonly authorizingIntegrationOwners: IntegrationTypeMap

Inherited from

Interaction.authorizingIntegrationOwners

Defined in

transformers/src/factories/interaction.ts:87


context

readonly context: undefined | InteractionContextType

Inherited from

Interaction.context

Defined in

transformers/src/factories/interaction.ts:88


data

readonly data: T

Inherited from

Interaction.data

Defined in

transformers/src/factories/interaction.ts:89


message

readonly message: M

Inherited from

Interaction.message

Defined in

transformers/src/factories/interaction.ts:90


isPingInteraction()

isPingInteraction: () => this is GuildInteraction<undefined, undefined>

Returns

this is GuildInteraction<undefined, undefined>

Overrides

Interaction.isPingInteraction

Defined in

transformers/src/factories/interaction.ts:394


isApplicationCommandInteraction()

isApplicationCommandInteraction: () => this is GuildInteraction<ApplicationCommandData<undefined>, undefined>

Returns

this is GuildInteraction<ApplicationCommandData<undefined>, undefined>

Overrides

Interaction.isApplicationCommandInteraction

Defined in

transformers/src/factories/interaction.ts:395


isAutocompleteInteraction()

isAutocompleteInteraction: () => this is GuildInteraction<AutocompleteData, undefined>

Returns

this is GuildInteraction<AutocompleteData, undefined>

Overrides

Interaction.isAutocompleteInteraction

Defined in

transformers/src/factories/interaction.ts:396


isMessageComponentInteraction()

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

Returns

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

Overrides

Interaction.isMessageComponentInteraction

Defined in

transformers/src/factories/interaction.ts:397


isModalSubmitInteraction()

isModalSubmitInteraction: () => this is GuildInteraction<ModalSubmitData, undefined>

Returns

this is GuildInteraction<ModalSubmitData, undefined>

Overrides

Interaction.isModalSubmitInteraction

Defined in

transformers/src/factories/interaction.ts:398


guildId

readonly guildId: string

Defined in

transformers/src/factories/interaction.ts:407


channel

readonly channel: PartialChannel

Defined in

transformers/src/factories/interaction.ts:408


channelId

readonly channelId: string

Defined in

transformers/src/factories/interaction.ts:409


member

readonly member: GuildMember

Defined in

transformers/src/factories/interaction.ts:410


guildLocale

readonly guildLocale: Locale

Defined in

transformers/src/factories/interaction.ts:411

Methods

reply()

reply(content, options)

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

Parameters
ParameterType
contentstring
options?InteractionReplyOptions
Returns

Promise<void>

Inherited from

Interaction.reply

Defined in

transformers/src/factories/interaction.ts:113

reply(options)

reply(options): Promise<void>

Parameters
ParameterType
optionsInteractionReplyOptions
Returns

Promise<void>

Inherited from

Interaction.reply

Defined in

transformers/src/factories/interaction.ts:114


deferReply()

deferReply(ephemeral): Promise<void>

Parameters

ParameterTypeDefault value
ephemeralbooleanfalse

Returns

Promise<void>

Inherited from

Interaction.deferReply

Defined in

transformers/src/factories/interaction.ts:160


deferComponentReply()

deferComponentReply(ephemeral): Promise<void>

Parameters

ParameterTypeDefault value
ephemeralbooleanfalse

Returns

Promise<void>

Inherited from

Interaction.deferComponentReply

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>

Inherited from

Interaction.updateComponents

Defined in

transformers/src/factories/interaction.ts:178

updateComponents(options)

updateComponents(options): Promise<void>

Parameters
ParameterType
optionsInteractionReplyOptions
Returns

Promise<void>

Inherited from

Interaction.updateComponents

Defined in

transformers/src/factories/interaction.ts:179


showChoices()

showChoices(choices): Promise<void>

Parameters

ParameterType
choicesChoiceStructure[]

Returns

Promise<void>

Inherited from

Interaction.showChoices

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>

Inherited from

Interaction.showModal

Defined in

transformers/src/factories/interaction.ts:232

showModal(options)

showModal(options): Promise<void>

Parameters
ParameterType
optionsInteractionShowModalOptions
Returns

Promise<void>

Inherited from

Interaction.showModal

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>

Inherited from

Interaction.followUp

Defined in

transformers/src/factories/interaction.ts:258

followUp(options)

followUp(options): Promise<Message>

Parameters
ParameterType
optionsInteractionReplyOptions
Returns

Promise<Message>

Inherited from

Interaction.followUp

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>

Inherited from

Interaction.editReply

Defined in

transformers/src/factories/interaction.ts:302

editReply(options)

editReply(options): Promise<Message>

Parameters
ParameterType
optionsInteractionEditOptions
Returns

Promise<Message>

Inherited from

Interaction.editReply

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>

Inherited from

Interaction.editFollowUp

Defined in

transformers/src/factories/interaction.ts:327

editFollowUp(messageId, options)

editFollowUp(messageId, options): Promise<Message>

Parameters
ParameterType
messageIdstring
optionsInteractionEditOptions
Returns

Promise<Message>

Inherited from

Interaction.editFollowUp

Defined in

transformers/src/factories/interaction.ts:328


deleteReply()

deleteReply(): Promise<void>

Returns

Promise<void>

Inherited from

Interaction.deleteReply

Defined in

transformers/src/factories/interaction.ts:352


deleteFollowUp()

deleteFollowUp(messageId): Promise<void>

Parameters

ParameterType
messageIdstring

Returns

Promise<void>

Inherited from

Interaction.deleteFollowUp

Defined in

transformers/src/factories/interaction.ts:356


fetchOriginalReply()

fetchOriginalReply(): Promise<Structure>

Returns

Promise<Structure>

Inherited from

Interaction.fetchOriginalReply

Defined in

transformers/src/factories/interaction.ts:360


inGuild()

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

Returns

this is GuildInteraction<T, M>

Inherited from

Interaction.inGuild

Defined in

transformers/src/factories/interaction.ts:384


inDM()

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

Returns

this is DMInteraction<T, M>

Inherited from

Interaction.inDM

Defined in

transformers/src/factories/interaction.ts:388