ModalBuilder
BuilderOn this page
ModalBuilder is a fluent payload builder. Chain setters, then pass the builder to send, reply, or command registration.
Constructor
ModalBuilder.new() The class table is callable, so ModalBuilder() is the same as .new.
No parameters.
local discord = require("discord")
local object = discord.ModalBuilder()Properties
- Name
data- Type
any- Access
- readonly
- Description
- Instance field
ModalBuilder.data. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this ModalBuilder.
Methods
ModalBuilder:addComponents()
#Add Components to this ModalBuilder.
Signature
ModalBuilder:addComponents(...) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
... |
any |
required | Passed through to the implementation as written. |
Returns
ModalBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a ModalBuilder
object:addComponents(...)Performs from on this ModalBuilder. Call it from bot code when you need that operation on the current object.
Signature
ModalBuilder.from(data) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
data |
any |
required | Passed through to the implementation as written. |
Returns
ModalBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a ModalBuilder
ModalBuilder.from(data)ModalBuilder:setCustomId()
#Set the CustomId field. Builders return this ModalBuilder so setters can be chained.
Signature
ModalBuilder:setCustomId(id) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
id |
string |
required | Snowflake id string. |
Returns
ModalBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a ModalBuilder
object:setCustomId("123")ModalBuilder:setTitle()
#Set the Title field. Builders return this ModalBuilder so setters can be chained.
Signature
ModalBuilder:setTitle(title) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
title |
any |
required | Passed through to the implementation as written. |
Returns
ModalBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a ModalBuilder
object:setTitle(title)ModalBuilder:toJSON()
#Serialize this ModalBuilder into a Lua table suitable for REST or debugging.
Signature
ModalBuilder:toJSON() Parameters
No parameters.
Returns
ModalBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a ModalBuilder
object:toJSON()Examples
local discord = require("discord")
local object = discord.ModalBuilder({})Related APIs
ActionRowBuilder · AttachmentBuilder · ButtonBuilder · ChannelSelectMenuBuilder · CheckboxBuilder · ContainerBuilder · ContextMenuCommandBuilder · EmbedBuilder
Version: discord 1.2.4 · runtime 1.0.0