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