Modal

Implementation of the Discord Modal Interaction class in Luau

https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-structure

Summary

Properties

Modal.type :: stringModal.context :: stringModal.id :: stringModal.applicationId :: stringModal.data :: Classes.InteractionBehaviourData?Modal.guild :: Classes.UnavailableGuild?Modal.guildId :: string?Modal.channelId :: string?Modal.member :: Classes.Guild.Member?Modal.user :: Classes.User?Modal.token :: stringModal.version :: numberModal.message :: Classes.Message?Modal.appPermissions :: Classes.PermissionModal.locale :: string?Modal.guildLocale :: string?Modal.entitlements :: {Classes.Entitlement}Modal.authorizingIntegrationOwners :: {[string]: string}Modal.attachmentSizeLimit :: number?Modal.state :: StateModal.id :: stringModal.token :: stringModal.isDeferred :: boolean

Methods

Modal:getContent(customId: string) → string?Modal:sync(interactionData: apiTypes.InteractionObject)Modal:deferAsync() → future.FutureLike<string, nil>Modal:messageAsync(messageJSON: builders.messageJSON, responseMessage: boolean?) → future.FutureLike<string, message.Message?>Modal:modalAsync(modalJSON: builders.ModalJSON, responseMessage: boolean?) → future.FutureLike<string, message.Message?>Modal:getResponseAsync(threadId: string?) → future.FutureLike<string, message.Message>Modal:editResponseAsync(messageJSON: builders.messageJSON, threadId: string?) → future.FutureLike<string, message.Message>Modal:deleteResponseAsync() → future.FutureLike<string, nil>Modal:createFollowupResponseAsync(messageJSON: builders.messageJSON, threadId: string?) → future.FutureLike<string, message.Message>Modal:getFollowupResponseAsync(messageId: string, threadId: string?) → future.FutureLike<string, message.Message>Modal:editFollowupResponseAsync(messageId: apiTypes.Snowflake, messageJSON: builders.messageJSON, threadId: string?) → future.FutureLike<string, message.Message>Modal:deleteFollowupResponseAsync(messageId: string) → future.FutureLike<string, nil>

Functions

Modal.new(state: state.State, interactionData: apiTypes.InteractionObject) → ModalModal.inheritProperties(class: any, interactionData: apiTypes.InteractionObject)Modal.inheritMethods(class: any)Modal.inheritProperties()Modal.inheritMethods(class: any)

Properties

type

Modal.type  :: string

---

The type of interaction. This can be one of the following values:

• “PING”
• “APPLICATION_COMMAND”
• “MESSAGE_COMPONENT”
• “APPLICATION_COMMAND_AUTOCOMPLETE”
• “MODAL_SUBMIT”

Inherited from Classes.Interactions.InteractionBehaviour

context

Modal.context  :: string

---

The context type of the interaction. This can be one of the following values:

• “GUILD”
• “BOT_DM”
• “PRIVATE_CHANNEL”

Inherited from Classes.Interactions.InteractionBehaviour

id

Modal.id  :: string

---

The unique identifier for the interaction.

Inherited from Classes.Interactions.InteractionBehaviour

applicationId

Modal.applicationId  :: string

---

The ID of the application this interaction is for.

Inherited from Classes.Interactions.InteractionBehaviour

data

Modal.data  :: InteractionBehaviourData?

---

The data associated with the interaction. The structure of this data varies based on the interaction type.

Inherited from Classes.Interactions.InteractionBehaviour

guild

Modal.guild  :: UnavailableGuild?

---

The guild where the interaction was triggered. This is only present for guild interactions.

Inherited from Classes.Interactions.InteractionBehaviour

guildId

Modal.guildId  :: string?

---

The ID of the guild where the interaction was triggered. This is only present for guild interactions.

Inherited from Classes.Interactions.InteractionBehaviour

channelId

Modal.channelId  :: string?

---

The ID of the channel where the interaction was triggered.

Inherited from Classes.Interactions.InteractionBehaviour

member

Modal.member  :: Member?

---

The member who triggered the interaction. This is only present for guild interactions.

Inherited from Classes.Interactions.InteractionBehaviour

user

Modal.user  :: User?

---

The user who triggered the interaction.

Inherited from Classes.Interactions.InteractionBehaviour

token

Modal.token  :: string

---

The token used for responding to the interaction.

Inherited from Classes.Interactions.InteractionBehaviour

version

Modal.version  :: number

---

The version of the interaction.

Inherited from Classes.Interactions.InteractionBehaviour

message

Modal.message  :: Message?

---

The message that triggered the interaction. This is only present for message component interactions.

Inherited from Classes.Interactions.InteractionBehaviour

appPermissions

Modal.appPermissions  :: Permission

---

The permissions the application has in the channel where the interaction was triggered.

Inherited from Classes.Interactions.InteractionBehaviour

locale

Modal.locale  :: string?

---

The selected language of the user who triggered the interaction.

Inherited from Classes.Interactions.InteractionBehaviour

guildLocale

Modal.guildLocale  :: string?

---

The guild’s preferred locale, if the interaction was triggered in a guild.

Inherited from Classes.Interactions.InteractionBehaviour

entitlements

Modal.entitlements  :: Entitlement}

---

The entitlements for the user who triggered the interaction.

Inherited from Classes.Interactions.InteractionBehaviour

authorizingIntegrationOwners

Modal.authorizingIntegrationOwners  :: {
{[string]: string} }

---

The mapping of integration types to their respective owners.

Inherited from Classes.Interactions.InteractionBehaviour

attachmentSizeLimit

Modal.attachmentSizeLimit  :: number?

---

The maximum attachment size in bytes for this interaction, varies by guild boost tier and the invoking user’s Nitro status.

Inherited from Classes.Interactions.InteractionBehaviour

state

Modal.state  :: State

---

The state object for this interaction.

Inherited from Classes.Interactions.Interactable

id

Modal.id  :: string

---

The ID of the interaction.

Inherited from Classes.Interactions.Interactable

token

Modal.token  :: string

---

The token for this interaction.

Inherited from Classes.Interactions.Interactable

isDeferred

Modal.isDeferred  :: boolean

---

Whether this interaction has been deferred.

Inherited from Classes.Interactions.Interactable

Methods

getContent

Modal : getContent ( customId )  -> string?

Gets the content of a text input component with the specified custom ID.

Parameters

customId: string

Returns

string?

sync

Modal : sync ( interactionData )  -> ()

Responsible for syncing data to this modal interaction object. This is typically called by the API when this object is created or updated.

Parameters

interactionData: InteractionObject

deferAsync

Modal : deferAsync ( )  -> FutureLike<string, nil>

Acknowledge an interaction and edit a response later, the user sees a loading state.

Returns

FutureLike<string, nil>

Inherited from Classes.Interactions.Interactable

messageAsync

Modal : messageAsync ( messageJSON ,  responseMessage )  -> FutureLike<string, Message?>

Respond to this interaction with a message.

Parameters

messageJSON: messageJSON
responseMessage: boolean?

Returns

FutureLike<string, Message?>

Inherited from Classes.Interactions.Interactable

modalAsync

Modal : modalAsync ( modalJSON ,  responseMessage )  -> FutureLike<string, Message?>

Respond to this interaction with a modal.

Parameters

modalJSON: ModalJSON
responseMessage: boolean?

Returns

FutureLike<string, Message?>

Inherited from Classes.Interactions.Interactable

getResponseAsync

Modal : getResponseAsync ( threadId )  -> FutureLike<string, Message>

Get the response created by this interaction.

Parameters

threadId: string?

Returns

FutureLike<string, Message>

Inherited from Classes.Interactions.Interactable

editResponseAsync

Modal : editResponseAsync ( messageJSON ,  threadId )  -> FutureLike<string, Message>

Edit the response made by this interaction.

Parameters

messageJSON: messageJSON
threadId: string?

Returns

FutureLike<string, Message>

Inherited from Classes.Interactions.Interactable

deleteResponseAsync

Modal : deleteResponseAsync ( )  -> FutureLike<string, nil>

Delete the original response made by this interaction.

Returns

FutureLike<string, nil>

Inherited from Classes.Interactions.Interactable

createFollowupResponseAsync

Modal : createFollowupResponseAsync ( messageJSON ,  threadId )  -> FutureLike<string, Message>

Create a followup response to an interaction, followup responses are messages you can send after the initial response is sent.

Parameters

messageJSON: messageJSON
threadId: string?

Returns

FutureLike<string, Message>

Inherited from Classes.Interactions.Interactable

getFollowupResponseAsync

Modal : getFollowupResponseAsync ( messageId ,  threadId )  -> FutureLike<string, Message>

Get the followup response created by this interaction.

Parameters

messageId: string
threadId: string?

Returns

FutureLike<string, Message>

Inherited from Classes.Interactions.Interactable

editFollowupResponseAsync

Modal : editFollowupResponseAsync ( messageId ,  messageJSON ,  threadId )  -> FutureLike<string, Message>

Edit the followup response created by this interaction.

Parameters

messageId: Snowflake
messageJSON: messageJSON
threadId: string?

Returns

FutureLike<string, Message>

Inherited from Classes.Interactions.Interactable

deleteFollowupResponseAsync

Modal : deleteFollowupResponseAsync ( messageId )  -> FutureLike<string, nil>

Delete the followup response created by this interaction.

Parameters

messageId: string

Returns

FutureLike<string, nil>

Inherited from Classes.Interactions.Interactable

Functions

new

Modal . new ( state ,  interactionData )  -> Modal

Responsible for constructing this class.

Parameters

state: State
interactionData: InteractionObject

Returns

Modal

inheritProperties

Modal . inheritProperties ( class ,  interactionData )  -> ()

Responsible for inheriting properties from the interaction data to the class instance. This function initializes all the properties of an Interaction instance based on the provided interaction data.

Parameters

class: any
interactionData: InteractionObject

Inherited from Classes.Interactions.InteractionBehaviour

inheritMethods

Modal . inheritMethods ( class )  -> ()

Responsible for inheriting methods from the Interaction prototype to the class instance. This function copies all methods from the Interaction.Prototype to the provided class instance.

Parameters

class: any

Inherited from Classes.Interactions.InteractionBehaviour

inheritProperties

Modal . inheritProperties ( )  -> ()

Inherit properties from the Interaction class.

Inherited from Classes.Interactions.Interactable

inheritMethods

Modal . inheritMethods ( class )  -> ()

Inherit methods from the Interaction class.

Parameters

class: any

Inherited from Classes.Interactions.Interactable