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