GuildInteraction

Extends

• Interaction<T, M>

Type Parameters

Type Parameter	Default type
T extends InteractionData	-
M extends undefined | Message	undefined | Message

Constructors

new GuildInteraction()

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

Parameters

Parameter	Type
client	Client
interaction	GuildStructure
isDM	boolean
data?	T

Returns

GuildInteraction<T, M>

Inherited from

Interaction<T, M>.constructor

Defined in

transformers/src/factories/interaction.ts:420

Properties

client

readonly client: Client

Inherited from

Interaction.client

Defined in

transformers/src/factories/interaction.ts:78

---

id

readonly id: string

Inherited from

Interaction.id

Defined in

transformers/src/factories/interaction.ts:79

---

applicationId

readonly applicationId: string

Inherited from

Interaction.applicationId

Defined in

transformers/src/factories/interaction.ts:80

---

type

readonly type: InteractionType

Inherited from

Interaction.type

Defined in

transformers/src/factories/interaction.ts:81

---

token

readonly token: string

Inherited from

Interaction.token

Defined in

transformers/src/factories/interaction.ts:82

---

version

readonly version: 1 = 1

Inherited from

Interaction.version

Defined in

transformers/src/factories/interaction.ts:83

---

appPermissions

readonly appPermissions: string

Inherited from

Interaction.appPermissions

Defined in

transformers/src/factories/interaction.ts:84

---

locale

readonly locale: undefined | Locale

This is only undefined if type is PING

Inherited from

Interaction.locale

Defined in

transformers/src/factories/interaction.ts:86

---

entitlements

readonly entitlements: EntitlementStructure[]

Inherited from

Interaction.entitlements

Defined in

transformers/src/factories/interaction.ts:87

---

authorizingIntegrationOwners

readonly authorizingIntegrationOwners: IntegrationTypeMap

Inherited from

Interaction.authorizingIntegrationOwners

Defined in

transformers/src/factories/interaction.ts:88

---

context

readonly context: undefined | InteractionContextType

Inherited from

Interaction.context

Defined in

transformers/src/factories/interaction.ts:89

---

data

readonly data: T

Inherited from

Interaction.data

Defined in

transformers/src/factories/interaction.ts:90

---

message

readonly message: M

Inherited from

Interaction.message

Defined in

transformers/src/factories/interaction.ts:91

---

isPingInteraction()

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

Returns

this is GuildInteraction<undefined, undefined>

Overrides

Interaction.isPingInteraction

Defined in

transformers/src/factories/interaction.ts:401

---

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

---

isAutocompleteInteraction()

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

Returns

this is GuildInteraction<AutocompleteData, undefined>

Overrides

Interaction.isAutocompleteInteraction

Defined in

transformers/src/factories/interaction.ts:403

---

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

---

isModalSubmitInteraction()

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

Returns

this is GuildInteraction<ModalSubmitData, undefined>

Overrides

Interaction.isModalSubmitInteraction

Defined in

transformers/src/factories/interaction.ts:405

---

guildId

readonly guildId: string

Defined in

transformers/src/factories/interaction.ts:414

---

channel

readonly channel: PartialChannel

Defined in

transformers/src/factories/interaction.ts:415

---

channelId

readonly channelId: string

Defined in

transformers/src/factories/interaction.ts:416

---

member

readonly member: GuildMember

Defined in

transformers/src/factories/interaction.ts:417

---

guildLocale

readonly guildLocale: Locale

Defined in

transformers/src/factories/interaction.ts:418

Methods

reply()

reply(content, options)

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

Parameters

Parameter	Type
content	string
options?	InteractionReplyOptions

Returns

Promise<void>

Inherited from

Interaction.reply

Defined in

transformers/src/factories/interaction.ts:114

reply(options)

reply(options): Promise<void>

Parameters

Parameter	Type
options	InteractionReplyOptions

Returns

Promise<void>

Inherited from

Interaction.reply

Defined in

transformers/src/factories/interaction.ts:115

---

deferReply()

deferReply(ephemeral): Promise<void>

Parameters

Parameter	Type	Default value
ephemeral	boolean	false

Returns

Promise<void>

Inherited from

Interaction.deferReply

Defined in

transformers/src/factories/interaction.ts:163

---

deferComponentReply()

deferComponentReply(ephemeral): Promise<void>

Parameters

Parameter	Type	Default value
ephemeral	boolean	false

Returns

Promise<void>

Inherited from

Interaction.deferComponentReply

Defined in

transformers/src/factories/interaction.ts:172

---

updateComponents()

updateComponents(content, options)

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

Parameters

Parameter	Type
content	string
options?	InteractionReplyOptions

Returns

Promise<void>

Inherited from

Interaction.updateComponents

Defined in

transformers/src/factories/interaction.ts:181

updateComponents(options)

updateComponents(options): Promise<void>

Parameters

Parameter	Type
options	InteractionReplyOptions

Returns

Promise<void>

Inherited from

Interaction.updateComponents

Defined in

transformers/src/factories/interaction.ts:182

---

showChoices()

showChoices(choices): Promise<void>

Parameters

Parameter	Type
choices	ChoiceStructure[]

Returns

Promise<void>

Inherited from

Interaction.showChoices

Defined in

transformers/src/factories/interaction.ts:230

---

showModal()

showModal(title, id, components)

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

Parameters

Parameter	Type
title	string
id	string
components	ActionRowStructure[]

Returns

Promise<void>

Inherited from

Interaction.showModal

Defined in

transformers/src/factories/interaction.ts:237

showModal(options)

showModal(options): Promise<void>

Parameters

Parameter	Type
options	InteractionShowModalOptions

Returns

Promise<void>

Inherited from

Interaction.showModal

Defined in

transformers/src/factories/interaction.ts:238

---

followUp()

followUp(content, options)

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

Parameters

Parameter	Type
content	string
options?	InteractionReplyOptions

Returns

Promise<Message>

Inherited from

Interaction.followUp

Defined in

transformers/src/factories/interaction.ts:263

followUp(options)

followUp(options): Promise<Message>

Parameters

Parameter	Type
options	InteractionReplyOptions

Returns

Promise<Message>

Inherited from

Interaction.followUp

Defined in

transformers/src/factories/interaction.ts:264

---

editReply()

editReply(content, options)

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

Parameters

Parameter	Type
content	string
options?	InteractionEditOptions

Returns

Promise<Message>

Inherited from

Interaction.editReply

Defined in

transformers/src/factories/interaction.ts:309

editReply(options)

editReply(options): Promise<Message>

Parameters

Parameter	Type
options	InteractionEditOptions

Returns

Promise<Message>

Inherited from

Interaction.editReply

Defined in

transformers/src/factories/interaction.ts:310

---

editFollowUp()

editFollowUp(messageId, content, options)

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

Parameters

Parameter	Type
messageId	string
content	string
options?	InteractionEditOptions

Returns

Promise<Message>

Inherited from

Interaction.editFollowUp

Defined in

transformers/src/factories/interaction.ts:334

editFollowUp(messageId, options)

editFollowUp(messageId, options): Promise<Message>

Parameters

Parameter	Type
messageId	string
options	InteractionEditOptions

Returns

Promise<Message>

Inherited from

Interaction.editFollowUp

Defined in

transformers/src/factories/interaction.ts:335

---

deleteReply()

deleteReply(): Promise<void>

Returns

Promise<void>

Inherited from

Interaction.deleteReply

Defined in

transformers/src/factories/interaction.ts:359

---

deleteFollowUp()

deleteFollowUp(messageId): Promise<void>

Parameters

Parameter	Type
messageId	string

Returns

Promise<void>

Inherited from

Interaction.deleteFollowUp

Defined in

transformers/src/factories/interaction.ts:363

---

fetchOriginalReply()

fetchOriginalReply(): Promise<Structure>

Returns

Promise<Structure>

Inherited from

Interaction.fetchOriginalReply

Defined in

transformers/src/factories/interaction.ts:367

---

inGuild()

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

Returns

this is GuildInteraction<T, M>

Inherited from

Interaction.inGuild

Defined in

transformers/src/factories/interaction.ts:391

---

inDM()

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

Returns

this is DMInteraction<T, M>

Inherited from

Interaction.inDM

Defined in

transformers/src/factories/interaction.ts:395