EmbedBuilder

Represents a embed in a message (image/video preview, rich embed, etc.)
declare class EmbedBuilder 

constructor(data?)

Constructs a new instance of the EmbedBuilder class
NameTypeOptionalDescription
dataAPIEmbedYesNone
Readonly

addFields(fields)

:

this

Adds fields to the embed (max 25)
NameTypeOptionalDescription
fieldsRestOrArray<APIEmbedField>No
The fields to add

setAuthor(options)

:

this

Sets the author of this embed
NameTypeOptionalDescription
optionsEmbedAuthorOptions | nullNo
The options for the author

setColor(color)

:

this

Sets the color of this embed
NameTypeOptionalDescription
colornumber | RGBTuple | nullNo
The color of the embed

setDescription(description)

:

this

Sets the description of this embed
NameTypeOptionalDescription
descriptionstring | nullNo
The description

setFields(fields)

:

this

Sets the embed's fields (max 25).
NameTypeOptionalDescription
fieldsRestOrArray<APIEmbedField>No
The fields to set

setFooter(options)

:

this

Sets the footer of this embed
NameTypeOptionalDescription
optionsEmbedFooterOptions | nullNo
The options for the footer

setImage(url)

:

this

Sets the image of this embed
NameTypeOptionalDescription
urlstring | nullNo
The URL of the image

setThumbnail(url)

:

this

Sets the thumbnail of this embed
NameTypeOptionalDescription
urlstring | nullNo
The URL of the thumbnail

setTimestamp(timestamp?)

:

this

Sets the timestamp of this embed
NameTypeOptionalDescription
timestampnumber | Date | nullYes
The timestamp or date

setTitle(title)

:

this

Sets the title of this embed
NameTypeOptionalDescription
titlestring | nullNo
The title

setURL(url)

:

this

Sets the URL of this embed
NameTypeOptionalDescription
urlstring | nullNo
The URL

spliceFields(index, deleteCount, fields)

:

this

Removes, replaces, or inserts fields in the embed (max 25)
NameTypeOptionalDescription
indexnumberNo
The index to start at
deleteCountnumberNo
The number of fields to remove
fieldsAPIEmbedField[]No
The replacing field objects

toJSON()

:

APIEmbed

Transforms the embed to a plain object