EmbedBuilder

Builder

On this page

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

builder Module 1.2.9 Source

Constructor

EmbedBuilder.new(data)

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

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

lua

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

Properties

EmbedBuilder.data

# readonly

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

Methods

EmbedBuilder:addField()

Add Field to this EmbedBuilder.

Signature

EmbedBuilder:addField(name, value, inline)

Parameters

Name	Type	Required	Behavior
`name`	`any`	required	Passed through to the implementation as written.
`value`	`any`	required	Passed through to the implementation as written.
`inline`	`any`	required	Passed through to the implementation as written.

Returns

EmbedBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a EmbedBuilder
object:addField(name, value, inline)

EmbedBuilder:addFields()

Add Fields to this EmbedBuilder.

Signature

EmbedBuilder:addFields(...)

Parameters

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

Returns

EmbedBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a EmbedBuilder
object:addFields(...)

EmbedBuilder:clearFields()

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

Signature

EmbedBuilder:clearFields()

Parameters

No parameters.

Returns

EmbedBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a EmbedBuilder
object:clearFields()

EmbedBuilder.from()

# static

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

Signature

EmbedBuilder.from(other)

Parameters

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

Returns

EmbedBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a EmbedBuilder
EmbedBuilder.from(other)

EmbedBuilder:setAuthor()

Set the Author field. Builders return this EmbedBuilder so setters can be chained.

Signature

EmbedBuilder:setAuthor(author)

Parameters

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

Returns

EmbedBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a EmbedBuilder
object:setAuthor(author)

EmbedBuilder:setColor()

Set the Color field. Builders return this EmbedBuilder so setters can be chained.

Signature

EmbedBuilder:setColor(color)

Parameters

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

Returns

EmbedBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a EmbedBuilder
object:setColor(color)

EmbedBuilder:setDescription()

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

Signature

EmbedBuilder:setDescription(description)

Parameters

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

Returns

EmbedBuilder — the same instance, for chaining.

Example

lua

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

EmbedBuilder:setFields()

Set the Fields field. Builders return this EmbedBuilder so setters can be chained.

Signature

EmbedBuilder:setFields(...)

Parameters

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

Returns

EmbedBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a EmbedBuilder
object:setFields(...)

EmbedBuilder:setFooter()

Set the Footer field. Builders return this EmbedBuilder so setters can be chained.

Signature

EmbedBuilder:setFooter(footer)

Parameters

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

Returns

EmbedBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a EmbedBuilder
object:setFooter(footer)

EmbedBuilder:setImage()

Set the Image field. Builders return this EmbedBuilder so setters can be chained.

Signature

EmbedBuilder:setImage(url)

Parameters

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

Returns

EmbedBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a EmbedBuilder
object:setImage(url)

EmbedBuilder:setThumbnail()

Set the Thumbnail field. Builders return this EmbedBuilder so setters can be chained.

Signature

EmbedBuilder:setThumbnail(url)

Parameters

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

Returns

EmbedBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a EmbedBuilder
object:setThumbnail(url)

EmbedBuilder:setTimestamp()

Set the Timestamp field. Builders return this EmbedBuilder so setters can be chained.

Signature

EmbedBuilder:setTimestamp(timestamp)

Parameters

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

Returns

EmbedBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a EmbedBuilder
object:setTimestamp(timestamp)

EmbedBuilder:setTitle()

Set the Title field. Builders return this EmbedBuilder so setters can be chained.

Signature

EmbedBuilder:setTitle(title)

Parameters

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

Returns

EmbedBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a EmbedBuilder
object:setTitle(title)

EmbedBuilder:setUrl()

Set the Url field. Builders return this EmbedBuilder so setters can be chained.

Signature

EmbedBuilder:setUrl(url)

Parameters

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

Returns

EmbedBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a EmbedBuilder
object:setUrl(url)

EmbedBuilder:setURL()

Set the URL field. Builders return this EmbedBuilder so setters can be chained.

Signature

EmbedBuilder:setURL(url)

Parameters

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

Returns

EmbedBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a EmbedBuilder
object:setURL(url)

EmbedBuilder:setVideo()

Set the Video field. Builders return this EmbedBuilder so setters can be chained.

Signature

EmbedBuilder:setVideo(url)

Parameters

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

Returns

EmbedBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a EmbedBuilder
object:setVideo(url)

EmbedBuilder:spliceFields()

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

Signature

EmbedBuilder:spliceFields(index, deleteCount, ...)

Parameters

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

Returns

EmbedBuilder — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a EmbedBuilder
object:spliceFields(index, deleteCount, ...)

EmbedBuilder:toJSON()

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

Signature

EmbedBuilder:toJSON()

Parameters

No parameters.

Returns

EmbedBuilder — the same instance, for chaining.

Example

lua

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

Static members

EmbedBuilder.equals

Examples

lua

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

ActionRowBuilder · AttachmentBuilder · BaseSelectMenuBuilder · ButtonBuilder · ChannelSelectMenuBuilder · CheckboxBuilder · ComponentBuilder · ContainerBuilder

Version: discord 1.2.9 · runtime 1.0.0