SectionBuilder
BuilderOn this page
SectionBuilder is a fluent payload builder. Chain setters, then pass the builder to send, reply, or command registration.
Constructor
SectionBuilder.new() The class table is callable, so SectionBuilder() is the same as .new.
No parameters.
local discord = require("discord")
local object = discord.SectionBuilder()Properties
- Name
data- Type
any- Access
- readonly
- Description
- Instance field
SectionBuilder.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 SectionBuilder.
Methods
SectionBuilder:addTextDisplayComponents()
#Add TextDisplayComponents to this SectionBuilder.
Signature
SectionBuilder:addTextDisplayComponents(...) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
... |
any |
required | Passed through to the implementation as written. |
Returns
SectionBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a SectionBuilder
object:addTextDisplayComponents(...)SectionBuilder:setButtonAccessory()
#Set the ButtonAccessory field. Builders return this SectionBuilder so setters can be chained.
Signature
SectionBuilder:setButtonAccessory(accessory) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
accessory |
any |
required | Passed through to the implementation as written. |
Returns
SectionBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a SectionBuilder
object:setButtonAccessory(accessory)SectionBuilder:setPrimaryButtonAccessory()
#Set the PrimaryButtonAccessory field. Builders return this SectionBuilder so setters can be chained.
Signature
SectionBuilder:setPrimaryButtonAccessory(accessory) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
accessory |
any |
required | Passed through to the implementation as written. |
Returns
SectionBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a SectionBuilder
object:setPrimaryButtonAccessory(accessory)SectionBuilder:setTextDisplayComponents()
#Set the TextDisplayComponents field. Builders return this SectionBuilder so setters can be chained.
Signature
SectionBuilder:setTextDisplayComponents(...) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
... |
any |
required | Passed through to the implementation as written. |
Returns
SectionBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a SectionBuilder
object:setTextDisplayComponents(...)SectionBuilder:setThumbnailAccessory()
#Set the ThumbnailAccessory field. Builders return this SectionBuilder so setters can be chained.
Signature
SectionBuilder:setThumbnailAccessory(accessory) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
accessory |
any |
required | Passed through to the implementation as written. |
Returns
SectionBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a SectionBuilder
object:setThumbnailAccessory(accessory)SectionBuilder:spliceTextDisplayComponents()
#Performs splice text display components on this SectionBuilder. Call it from bot code when you need that operation on the current object.
Signature
SectionBuilder:spliceTextDisplayComponents(index, deleteCount, ...) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
index |
any |
required | Passed through to the implementation as written. |
deleteCount |
any |
required | Passed through to the implementation as written. |
... |
any |
required | Passed through to the implementation as written. |
Returns
SectionBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a SectionBuilder
object:spliceTextDisplayComponents(index, deleteCount, ...)SectionBuilder:toJSON()
#Serialize this SectionBuilder into a Lua table suitable for REST or debugging.
Signature
SectionBuilder:toJSON() Parameters
No parameters.
Returns
SectionBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a SectionBuilder
object:toJSON()Examples
local discord = require("discord")
local object = discord.SectionBuilder({})Related APIs
ActionRowBuilder · AttachmentBuilder · BaseSelectMenuBuilder · ButtonBuilder · ChannelSelectMenuBuilder · CheckboxBuilder · ComponentBuilder · ContainerBuilder
Version: discord 1.2.9 · runtime 1.0.0