LabelBuilder

Builder

On this page

LabelBuilder is a fluent payload builder. Chain setters, then pass the builder to send, reply, or command registration.

builder Module 1.2.4 Source

Constructor

LabelBuilder.new()

The class table is callable, so LabelBuilder() is the same as .new.

No parameters.

lua

local discord = require("discord")
local object = discord.LabelBuilder()

Properties

LabelBuilder.data

# readonly

Name: data
Type: any
Access: readonly
Description: Instance field LabelBuilder.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 LabelBuilder.

Methods

LabelBuilder:clearDescription()

Performs clear description on this LabelBuilder. Call it from bot code when you need that operation on the current object.

Signature

LabelBuilder:clearDescription()

Parameters

No parameters.

Returns

LabelBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a LabelBuilder
object:clearDescription()

LabelBuilder.from()

# static

Performs from on this LabelBuilder. Call it from bot code when you need that operation on the current object.

Signature

LabelBuilder.from(data)

Parameters

Name	Type	Required	Behavior
`data`	`any`	required	Passed through to the implementation as written.

Returns

LabelBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a LabelBuilder
LabelBuilder.from(data)

LabelBuilder:setChannelSelectMenuComponent()

Set the ChannelSelectMenuComponent field. Builders return this LabelBuilder so setters can be chained.

Signature

LabelBuilder:setChannelSelectMenuComponent(input)

Parameters

Name	Type	Required	Behavior
`input`	`any`	required	Passed through to the implementation as written.

Returns

LabelBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a LabelBuilder
object:setChannelSelectMenuComponent(input)

LabelBuilder:setCheckboxComponent()

Set the CheckboxComponent field. Builders return this LabelBuilder so setters can be chained.

Signature

LabelBuilder:setCheckboxComponent(input)

Parameters

Name	Type	Required	Behavior
`input`	`any`	required	Passed through to the implementation as written.

Returns

LabelBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a LabelBuilder
object:setCheckboxComponent(input)

LabelBuilder:setCheckboxGroupComponent()

Set the CheckboxGroupComponent field. Builders return this LabelBuilder so setters can be chained.

Signature

LabelBuilder:setCheckboxGroupComponent(input)

Parameters

Name	Type	Required	Behavior
`input`	`any`	required	Passed through to the implementation as written.

Returns

LabelBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a LabelBuilder
object:setCheckboxGroupComponent(input)

LabelBuilder:setComponent()

Set the Component field. Builders return this LabelBuilder so setters can be chained.

Signature

LabelBuilder:setComponent(component)

Parameters

Name	Type	Required	Behavior
`component`	`any`	required	Passed through to the implementation as written.

Returns

LabelBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a LabelBuilder
object:setComponent(component)

LabelBuilder:setDescription()

Set the Description field. Builders return this LabelBuilder so setters can be chained.

Signature

LabelBuilder:setDescription(description)

Parameters

Name	Type	Required	Behavior
`description`	`any`	required	Passed through to the implementation as written.

Returns

LabelBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a LabelBuilder
object:setDescription(description)

LabelBuilder:setFileUploadComponent()

Set the FileUploadComponent field. Builders return this LabelBuilder so setters can be chained.

Signature

LabelBuilder:setFileUploadComponent(input)

Parameters

Name	Type	Required	Behavior
`input`	`any`	required	Passed through to the implementation as written.

Returns

LabelBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a LabelBuilder
object:setFileUploadComponent(input)

LabelBuilder:setId()

Set the Id field. Builders return this LabelBuilder so setters can be chained.

Signature

LabelBuilder:setId(id)

Parameters

Name	Type	Required	Behavior
`id`	`string`	required	Snowflake id string.

Returns

LabelBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a LabelBuilder
object:setId("123")

LabelBuilder:setLabel()

Set the Label field. Builders return this LabelBuilder so setters can be chained.

Signature

LabelBuilder:setLabel(label)

Parameters

Name	Type	Required	Behavior
`label`	`any`	required	Passed through to the implementation as written.

Returns

LabelBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a LabelBuilder
object:setLabel(label)

LabelBuilder:setMentionableSelectMenuComponent()

Set the MentionableSelectMenuComponent field. Builders return this LabelBuilder so setters can be chained.

Signature

LabelBuilder:setMentionableSelectMenuComponent(input)

Parameters

Name	Type	Required	Behavior
`input`	`any`	required	Passed through to the implementation as written.

Returns

LabelBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a LabelBuilder
object:setMentionableSelectMenuComponent(input)

LabelBuilder:setRadioGroupComponent()

Set the RadioGroupComponent field. Builders return this LabelBuilder so setters can be chained.

Signature

LabelBuilder:setRadioGroupComponent(input)

Parameters

Name	Type	Required	Behavior
`input`	`any`	required	Passed through to the implementation as written.

Returns

LabelBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a LabelBuilder
object:setRadioGroupComponent(input)

LabelBuilder:setRoleSelectMenuComponent()

Set the RoleSelectMenuComponent field. Builders return this LabelBuilder so setters can be chained.

Signature

LabelBuilder:setRoleSelectMenuComponent(input)

Parameters

Name	Type	Required	Behavior
`input`	`any`	required	Passed through to the implementation as written.

Returns

LabelBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a LabelBuilder
object:setRoleSelectMenuComponent(input)

LabelBuilder:setStringSelectMenuComponent()

Set the StringSelectMenuComponent field. Builders return this LabelBuilder so setters can be chained.

Signature

LabelBuilder:setStringSelectMenuComponent(input)

Parameters

Name	Type	Required	Behavior
`input`	`any`	required	Passed through to the implementation as written.

Returns

LabelBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a LabelBuilder
object:setStringSelectMenuComponent(input)

LabelBuilder:setTextInputComponent()

Set the TextInputComponent field. Builders return this LabelBuilder so setters can be chained.

Signature

LabelBuilder:setTextInputComponent(input)

Parameters

Name	Type	Required	Behavior
`input`	`any`	required	Passed through to the implementation as written.

Returns

LabelBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a LabelBuilder
object:setTextInputComponent(input)

LabelBuilder:setUserSelectMenuComponent()

Set the UserSelectMenuComponent field. Builders return this LabelBuilder so setters can be chained.

Signature

LabelBuilder:setUserSelectMenuComponent(input)

Parameters

Name	Type	Required	Behavior
`input`	`any`	required	Passed through to the implementation as written.

Returns

LabelBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a LabelBuilder
object:setUserSelectMenuComponent(input)

LabelBuilder:toJSON()

Serialize this LabelBuilder into a Lua table suitable for REST or debugging.

Signature

LabelBuilder:toJSON()

Parameters

No parameters.

Returns

LabelBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a LabelBuilder
object:toJSON()

Examples

lua

local discord = require("discord")
local object = discord.LabelBuilder({})

ActionRowBuilder · AttachmentBuilder · ButtonBuilder · ChannelSelectMenuBuilder · CheckboxBuilder · ContainerBuilder · ContextMenuCommandBuilder · EmbedBuilder

Version: discord 1.2.4 · runtime 1.0.0