TextDisplayBuilder
BuilderOn this page
TextDisplayBuilder is a fluent payload builder. Chain setters, then pass the builder to send, reply, or command registration.
Constructor
TextDisplayBuilder.new() The class table is callable, so TextDisplayBuilder() is the same as .new.
No parameters.
local discord = require("discord")
local object = discord.TextDisplayBuilder()Properties
- Name
data- Type
any- Access
- readonly
- Description
- Instance field
TextDisplayBuilder.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 TextDisplayBuilder.
Methods
TextDisplayBuilder:setContent()
#Set the Content field. Builders return this TextDisplayBuilder so setters can be chained.
Signature
TextDisplayBuilder:setContent(content) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
content |
string | table |
required | Message content string, or a send/reply payload table. |
Returns
TextDisplayBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a TextDisplayBuilder
object:setContent("Hello")TextDisplayBuilder:setId()
#Set the Id field. Builders return this TextDisplayBuilder so setters can be chained.
Signature
TextDisplayBuilder:setId(id) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
id |
string |
required | Snowflake id string. |
Returns
TextDisplayBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a TextDisplayBuilder
object:setId("123")TextDisplayBuilder:toJSON()
#Serialize this TextDisplayBuilder into a Lua table suitable for REST or debugging.
Signature
TextDisplayBuilder:toJSON() Parameters
No parameters.
Returns
TextDisplayBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a TextDisplayBuilder
object:toJSON()Examples
local discord = require("discord")
local object = discord.TextDisplayBuilder({})Related APIs
ActionRowBuilder · AttachmentBuilder · ButtonBuilder · ChannelSelectMenuBuilder · CheckboxBuilder · ContainerBuilder · ContextMenuCommandBuilder · EmbedBuilder
Version: discord 1.2.4 · runtime 1.0.0