Interface PrivateModalSubmitInteraction

Hierarchy

Omit<ModalSubmitInteraction<AnyPrivateChannel | Uncached>, "appPermissions" | "guild" | "guildID" | "guildLocale" | "member" | "memberPermissions">
- PrivateModalSubmitInteraction

Properties

acknowledged

acknowledged: boolean

If this interaction has been acknowledged.

`Optional` application

application?: ClientApplication

The application this interaction is for.

applicationID

applicationID: string

The ID of the application this interaction is for.

channel

channel: undefined | AnyPrivateChannel

channelID

channelID: string

The ID of the channel this interaction was sent from.

client

client: Client<ClientEvents>

createdAt

createdAt: Date

data

data: ModalSubmitInteractionData

The data associated with the interaction.

guild

guild: null

guildID

guildID: null

guildLocale

guildLocale: undefined

id

id: string

locale

locale: string

The locale of the invoking user.

member

member: null

memberPermissions

memberPermissions: null

`Optional` message

message?: Message<Uncached | AnyPrivateChannel>

The message this interaction is from, if the modal was triggered from a component interaction.

token

token: string

The token of this interaction.

type

type: MODAL_SUBMIT

user

user: User

The user that invoked this interaction.

version

version: 1

Read-only property, always 1

Methods

createFollowup

createFollowup(options: InteractionContent): Promise<Message<Uncached | AnyPrivateChannel>>
Create a followup message.
Parameters
- options: InteractionContent
  
  The options for creating the followup message.
Returns Promise<Message<Uncached | AnyPrivateChannel>>
Inherited from Omit.createFollowup
- Defined in lib/structures/ModalSubmitInteraction.ts:97

createMessage

createMessage(options: InitialInteractionContent): Promise<void>
Create a message through this interaction. This is an initial response, and more than one initial response cannot be used. Use createFollowup.

Note
You cannot attach files in an initial response. Defer the interaction, then use createFollowup.
Parameters
- options: InitialInteractionContent
  
  The options for the message.
Returns Promise<void>
Inherited from Omit.createMessage
- Defined in lib/structures/ModalSubmitInteraction.ts:106

defer

defer(flags?: number): Promise<void>
Defer this interaction. This is an initial response, and more than one initial response cannot be used.
Parameters
- Optional flags: number
  
  The flags to respond with.
Returns Promise<void>
Inherited from Omit.defer
- Defined in lib/structures/ModalSubmitInteraction.ts:121

deferUpdate

deferUpdate(flags?: number): Promise<void>
Defer this interaction with a DEFERRED_UPDATE_MESSAGE response. This is an initial response, and more than one initial response cannot be used.
Parameters
- Optional flags: number
  
  The flags to respond with.
Returns Promise<void>
Inherited from Omit.deferUpdate
- Defined in lib/structures/ModalSubmitInteraction.ts:133

deleteFollowup

deleteFollowup(messageID: string): Promise<void>
Delete a follow-up message.
Parameters
- messageID: string
  
  The ID of the message.
Returns Promise<void>
Inherited from Omit.deleteFollowup
- Defined in lib/structures/ModalSubmitInteraction.ts:145

deleteOriginal

deleteOriginal(): Promise<void>
Delete the original interaction response.

Returns Promise<void>
Inherited from Omit.deleteOriginal
- Defined in lib/structures/ModalSubmitInteraction.ts:152

editFollowup

editFollowup(messageID: string, options: InteractionContent): Promise<Message<Uncached | AnyPrivateChannel>>
Edit a followup message.
Parameters
- messageID: string
  
  The ID of the message.
- options: InteractionContent
  
  The options for editing the followup message.
Returns Promise<Message<Uncached | AnyPrivateChannel>>
Inherited from Omit.editFollowup
- Defined in lib/structures/ModalSubmitInteraction.ts:161

editOriginal

editOriginal(options: InteractionContent): Promise<Message<Uncached | AnyPrivateChannel>>
Edit the original interaction response.
Parameters
- options: InteractionContent
  
  The options for editing the original message.
Returns Promise<Message<Uncached | AnyPrivateChannel>>
Inherited from Omit.editOriginal
- Defined in lib/structures/ModalSubmitInteraction.ts:169

editParent

editParent(options: InteractionContent): Promise<void>
Edit the message this interaction is from. If this interaction has already been acknowledged, use createFollowup.
Parameters
- options: InteractionContent
  
  The options for editing the message.
Returns Promise<void>
Inherited from Omit.editParent
- Defined in lib/structures/ModalSubmitInteraction.ts:177

getFollowup

getFollowup(messageID: string): Promise<Message<Uncached | AnyPrivateChannel>>
Get a followup message.
Parameters
- messageID: string
  
  The ID of the message.
Returns Promise<Message<Uncached | AnyPrivateChannel>>
Inherited from Omit.getFollowup
- Defined in lib/structures/ModalSubmitInteraction.ts:189

getOriginal

getOriginal(): Promise<Message<Uncached | AnyPrivateChannel>>
Get the original interaction response.

Returns Promise<Message<Uncached | AnyPrivateChannel>>
Inherited from Omit.getOriginal
- Defined in lib/structures/ModalSubmitInteraction.ts:196

inCachedGuildChannel

inCachedGuildChannel(): this is ModalSubmitInteraction<AnyTextableGuildChannel>
Whether this interaction belongs to a cached guild channel. The only difference on using this method over a simple if statement is to easily update all the interaction properties typing definitions based on the channel it belongs to.

Returns this is ModalSubmitInteraction<AnyTextableGuildChannel>
Inherited from Omit.inCachedGuildChannel
- Defined in lib/structures/ModalSubmitInteraction.ts:201

inPrivateChannel

inPrivateChannel(): this is ModalSubmitInteraction<Uncached | PrivateChannel>
Whether this interaction belongs to a private channel (PrivateChannel or uncached). The only difference on using this method over a simple if statement is to easily update all the interaction properties typing definitions based on the channel it belongs to.

Returns this is ModalSubmitInteraction<Uncached | PrivateChannel>
Inherited from Omit.inPrivateChannel
- Defined in lib/structures/ModalSubmitInteraction.ts:206

toJSON

toJSON(): JSONModalSubmitInteraction
Returns JSONModalSubmitInteraction
Inherited from Omit.toJSON
- Defined in lib/structures/ModalSubmitInteraction.ts:210

toString

toString(): string
Returns string
Inherited from Omit.toString
- Defined in lib/structures/Base.ts:64

Interface PrivateModalSubmitInteraction

Hierarchy

Index

Properties

Methods

Properties

acknowledged

Optional application

applicationID

channel

channelID

client

createdAt

data

guild

guildID

guildLocale

id

locale

member

memberPermissions

Optional message

token

type

user

version

Methods

createFollowup

Parameters

options: InteractionContent

Returns Promise<Message<Uncached | AnyPrivateChannel>>

createMessage

Note

Parameters

options: InitialInteractionContent

Returns Promise<void>

defer

Parameters

Optional flags: number

Returns Promise<void>

deferUpdate

Parameters

Optional flags: number

Returns Promise<void>

deleteFollowup

Parameters

messageID: string

Returns Promise<void>

deleteOriginal

Returns Promise<void>

editFollowup

Parameters

messageID: string

options: InteractionContent

Returns Promise<Message<Uncached | AnyPrivateChannel>>

editOriginal

Parameters

options: InteractionContent

Returns Promise<Message<Uncached | AnyPrivateChannel>>

editParent

Parameters

options: InteractionContent

Returns Promise<void>

getFollowup

Parameters

messageID: string

Returns Promise<Message<Uncached | AnyPrivateChannel>>

getOriginal

Returns Promise<Message<Uncached | AnyPrivateChannel>>

inCachedGuildChannel

Returns this is ModalSubmitInteraction<AnyTextableGuildChannel>

inPrivateChannel

Returns this is ModalSubmitInteraction<Uncached | PrivateChannel>

toJSON

Returns JSONModalSubmitInteraction

toString

Returns string

Settings

Member Visibility

Theme

`Optional` application

`Optional` message

`Optional` flags: number

`Optional` flags: number