OptionBuilder
BuilderOn this page
OptionBuilder is a fluent payload builder. Chain setters, then pass the builder to send, reply, or command registration.
Constructor
OptionBuilder.new(optionType) The class table is callable, so OptionBuilder(optionType) is the same as .new.
| Name | Type | Required | Behavior |
|---|---|---|---|
optionType |
any |
required | Passed through to the implementation as written. |
local discord = require("discord")
local object = discord.OptionBuilder({})Properties
- Name
data- Type
any- Access
- readonly
- Description
- Instance field
OptionBuilder.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 OptionBuilder.
Methods
OptionBuilder:addChannelTypes()
#Add ChannelTypes to this OptionBuilder.
Signature
OptionBuilder:addChannelTypes(...) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
... |
any |
required | Passed through to the implementation as written. |
Returns
OptionBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a OptionBuilder
object:addChannelTypes(...)OptionBuilder:addChoices()
#Add Choices to this OptionBuilder.
Signature
OptionBuilder:addChoices(...) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
... |
any |
required | Passed through to the implementation as written. |
Returns
OptionBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a OptionBuilder
object:addChoices(...)OptionBuilder:setAutocomplete()
#Set the Autocomplete field. Builders return this OptionBuilder so setters can be chained.
Signature
OptionBuilder:setAutocomplete(enabled) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
enabled |
any |
required | Passed through to the implementation as written. |
Returns
OptionBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a OptionBuilder
object:setAutocomplete(enabled)OptionBuilder:setDescription()
#Set the Description field. Builders return this OptionBuilder so setters can be chained.
Signature
OptionBuilder:setDescription(description) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
description |
any |
required | Passed through to the implementation as written. |
Returns
OptionBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a OptionBuilder
object:setDescription(description)OptionBuilder:setDescriptionLocalizations()
#Set the DescriptionLocalizations field. Builders return this OptionBuilder so setters can be chained.
Signature
OptionBuilder:setDescriptionLocalizations(localizations) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
localizations |
any |
required | Passed through to the implementation as written. |
Returns
OptionBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a OptionBuilder
object:setDescriptionLocalizations(localizations)OptionBuilder:setMaxLength()
#Set the MaxLength field. Builders return this OptionBuilder so setters can be chained.
Signature
OptionBuilder:setMaxLength(value) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
value |
any |
required | Passed through to the implementation as written. |
Returns
OptionBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a OptionBuilder
object:setMaxLength(value)OptionBuilder:setMaxValue()
#Set the MaxValue field. Builders return this OptionBuilder so setters can be chained.
Signature
OptionBuilder:setMaxValue(value) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
value |
any |
required | Passed through to the implementation as written. |
Returns
OptionBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a OptionBuilder
object:setMaxValue(value)OptionBuilder:setMinLength()
#Set the MinLength field. Builders return this OptionBuilder so setters can be chained.
Signature
OptionBuilder:setMinLength(value) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
value |
any |
required | Passed through to the implementation as written. |
Returns
OptionBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a OptionBuilder
object:setMinLength(value)OptionBuilder:setMinValue()
#Set the MinValue field. Builders return this OptionBuilder so setters can be chained.
Signature
OptionBuilder:setMinValue(value) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
value |
any |
required | Passed through to the implementation as written. |
Returns
OptionBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a OptionBuilder
object:setMinValue(value)OptionBuilder:setName()
#Set the Name field. Builders return this OptionBuilder so setters can be chained.
Signature
OptionBuilder:setName(name) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
name |
any |
required | Passed through to the implementation as written. |
Returns
OptionBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a OptionBuilder
object:setName(name)OptionBuilder:setNameLocalizations()
#Set the NameLocalizations field. Builders return this OptionBuilder so setters can be chained.
Signature
OptionBuilder:setNameLocalizations(localizations) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
localizations |
any |
required | Passed through to the implementation as written. |
Returns
OptionBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a OptionBuilder
object:setNameLocalizations(localizations)OptionBuilder:setRequired()
#Set the Required field. Builders return this OptionBuilder so setters can be chained.
Signature
OptionBuilder:setRequired(required) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
required |
any |
required | Passed through to the implementation as written. |
Returns
OptionBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a OptionBuilder
object:setRequired(required)OptionBuilder:toJSON()
#Serialize this OptionBuilder into a Lua table suitable for REST or debugging.
Signature
OptionBuilder:toJSON() Parameters
No parameters.
Returns
OptionBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a OptionBuilder
object:toJSON()Static members
-
OptionBuilder.addAttachmentOption -
OptionBuilder.addBooleanOption -
OptionBuilder.addChannelOption -
OptionBuilder.addIntegerOption -
OptionBuilder.addMentionableOption -
OptionBuilder.addNumberOption -
OptionBuilder.addRoleOption -
OptionBuilder.addStringOption -
OptionBuilder.addSubcommand -
OptionBuilder.addUserOption
Examples
local discord = require("discord")
local object = discord.OptionBuilder({})Related APIs
ActionRowBuilder · AttachmentBuilder · ButtonBuilder · ChannelSelectMenuBuilder · CheckboxBuilder · ContainerBuilder · ContextMenuCommandBuilder · EmbedBuilder
Version: discord 1.2.4 · runtime 1.0.0