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