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