Class EmbedBuilder

Represents an embed in a message (image/video preview, rich embed, etc.)

Hierarchy

EmbedBuilder

Index

Constructors

constructor

Properties

data

Accessors

Methods

Constructors

constructor

new EmbedBuilder(data?: APIEmbed): EmbedBuilder

- Defined in src/builders/Embed.ts:22
Parameters
- Optional data: APIEmbed
Returns EmbedBuilder

Properties

data

The raw data of this embed

Accessors

author

get author(): undefined | APIEmbedAuthor

- Defined in src/builders/Embed.ts:72
The author of this embed

Returns undefined | APIEmbedAuthor

color

get color(): undefined | number

- Defined in src/builders/Embed.ts:47
The color of this embed

Returns undefined | number

description

get description(): undefined | string

- Defined in src/builders/Embed.ts:32
The description of this embed

Returns undefined | string

fields

get fields(): undefined | APIEmbedField[]

- Defined in src/builders/Embed.ts:82
The fields of this embed

Returns undefined | APIEmbedField[]

footer

get footer(): undefined | APIEmbedFooter

- Defined in src/builders/Embed.ts:52
The footer of this embed

Returns undefined | APIEmbedFooter

image

get image(): undefined | APIEmbedImage

- Defined in src/builders/Embed.ts:57
The image of this embed

Returns undefined | APIEmbedImage

provider

get provider(): undefined | APIEmbedProvider

- Defined in src/builders/Embed.ts:77
The provider of this embed

Returns undefined | APIEmbedProvider

thumbnail

get thumbnail(): undefined | APIEmbedThumbnail

- Defined in src/builders/Embed.ts:67
The thumbnail of this embed

Returns undefined | APIEmbedThumbnail

timestamp

get timestamp(): undefined | string

- Defined in src/builders/Embed.ts:42
The timestamp of this embed

Returns undefined | string

title

get title(): undefined | string

- Defined in src/builders/Embed.ts:27
The title of this embed

Returns undefined | string

url

get url(): undefined | string

- Defined in src/builders/Embed.ts:37
The URL of this embed

Returns undefined | string

video

get video(): undefined | APIEmbedVideo

- Defined in src/builders/Embed.ts:62
The video of this embed

Returns undefined | APIEmbedVideo

Methods

addField

addField(options: APIEmbedField): EmbedBuilder

- Defined in src/builders/Embed.ts:149
Adds a field to this embed

Parameters
- options: APIEmbedField
Returns EmbedBuilder

setAuthor

setAuthor(options: null | EmbedBuilderAuthorData): EmbedBuilder

- Defined in src/builders/Embed.ts:87
Sets the author of this embed

Parameters
- options: null | EmbedBuilderAuthorData
Returns EmbedBuilder

setColor

setColor(color: null | number): EmbedBuilder

- Defined in src/builders/Embed.ts:103
Sets the color of this embed

Parameters
- color: null | number
Returns EmbedBuilder

setDescription

setDescription(description: null | string): EmbedBuilder

- Defined in src/builders/Embed.ts:97
Sets the description of this embed

Parameters
- description: null | string
Returns EmbedBuilder

setFields

setFields(options?: APIEmbedField[]): EmbedBuilder

- Defined in src/builders/Embed.ts:156
Make the provided fields the only fields in this embed

Parameters
- options: APIEmbedField[] = []
Returns EmbedBuilder

setFooter

setFooter(options: null | EmbedBuilderFooterData): EmbedBuilder

- Defined in src/builders/Embed.ts:127
Make the provided field the only field in this embed

Parameters
- options: null | EmbedBuilderFooterData
Returns EmbedBuilder

setImage

setImage(url: null | string): EmbedBuilder

- Defined in src/builders/Embed.ts:137
Sets the image of this embed

Parameters
- url: null | string
Returns EmbedBuilder

setThumbnail

setThumbnail(url: null | string): EmbedBuilder

- Defined in src/builders/Embed.ts:143
Sets the thumbnail of this embed

Parameters
- url: null | string
Returns EmbedBuilder

setTimestamp

setTimestamp(timestamp?: null | number | Date): EmbedBuilder

- Defined in src/builders/Embed.ts:121
Sets the timestamp of this embed

Parameters
- timestamp: null | number | Date = ...
Returns EmbedBuilder

setTitle

setTitle(title: null | string): EmbedBuilder

- Defined in src/builders/Embed.ts:109
Sets the title of this embed

Parameters
- title: null | string
Returns EmbedBuilder

setURL

setURL(url: null | string): EmbedBuilder

- Defined in src/builders/Embed.ts:115
Sets the URL of this embed

Parameters
- url: null | string
Returns EmbedBuilder

toJSON

toJSON(): APIEmbed

- Defined in src/builders/Embed.ts:163
Returns the raw data of this embed

Returns APIEmbed

Generated using TypeDoc version 0.22.16, the 9/16/2022 at 1:09:15 AM