Class DiscordEmbed

Hierarchy

IDiscordEmbed
- DiscordEmbed

Implements

Partial<IDiscordEmbed>

Index

Constructors

constructor

new DiscordEmbed(): DiscordEmbed
Returns DiscordEmbed

Inherited from IDiscordEmbed.constructor

Properties

`Optional` author

author?: EmbedAuthor

author embed author object

Returns

EmbedAuthor

`Optional` color

color?: number

color color code of the embed

Returns

number

`Optional` description

description?: string

description description of embed

Returns

`Optional` fields

fields?: EmbedField[]

fields array of embed field objects

Returns

EmbedField

`Optional` footer

footer?: EmbedFooter

footer embed footer object

Returns

EmbedFooter

`Optional` image

image?: EmbedImage

image embed image object

Returns

EmbedImage

`Optional` provider

provider?: EmbedProvider

provider embed provider object

Returns

EmbedProvider

`Optional` thumbnail

thumbnail?: EmbedThumbnail

thumbnail embed thumbnail object

Returns

EmbedThumbnail

`Optional` timestamp

timestamp?: string | Date

timestamp timestamp fo embed content

Returns

string

`Optional` title

title?: string

title title of embed

Returns

string

`Optional` type

type?: EmbedType

type type of embed(always "rich" for webhook embeds)

Returns

EmbedType

`Optional` url

url?: string

url url of embed

Returns

string

`Optional` video

video?: EmbedVideo

video embed video object

Returns

EmbedVideo

Methods

setAuthor

setAuthor(options): EmbedAuthor | DiscordEmbed
Parameters
- options: string | EmbedAuthor
Returns EmbedAuthor | DiscordEmbed
- Defined in structures/DiscordEmbed.ts:96

setColor

setColor(color): DiscordEmbed
Parameters
- color: number
Returns DiscordEmbed
- Defined in structures/DiscordEmbed.ts:35

setDescription

setDescription(description): DiscordEmbed
Parameters
- description: string
Returns DiscordEmbed
- Defined in structures/DiscordEmbed.ts:25

setFields

setFields(options): DiscordEmbed | EmbedFooter[]
Parameters
- options: EmbedFooter[]
Returns DiscordEmbed | EmbedFooter[]
- Defined in structures/DiscordEmbed.ts:109

setFooter

setFooter(options): EmbedFooter | DiscordEmbed
Parameters
- options: string | EmbedFooter
Returns EmbedFooter | DiscordEmbed
- Defined in structures/DiscordEmbed.ts:40

setImage

setImage(options): EmbedImage | DiscordEmbed
Parameters
- options: string | EmbedImage
Returns EmbedImage | DiscordEmbed
- Defined in structures/DiscordEmbed.ts:52

setProvider

setProvider(options): EmbedProvider | DiscordEmbed
Parameters
- options: EmbedProvider
Returns EmbedProvider | DiscordEmbed
- Defined in structures/DiscordEmbed.ts:91

setThumbnail

setThumbnail(options): EmbedThumbnail | DiscordEmbed
Parameters
- options: string | EmbedThumbnail
Returns EmbedThumbnail | DiscordEmbed
- Defined in structures/DiscordEmbed.ts:65

setTimestamp

setTimestamp(timestamp?): DiscordEmbed
Parameters
- Optional timestamp: string | number | Date
Returns DiscordEmbed
- Defined in structures/DiscordEmbed.ts:30

setTitle

setTitle(title): DiscordEmbed
Parameters
- title: string
Returns DiscordEmbed
- Defined in structures/DiscordEmbed.ts:15

setType

setType(type): EmbedType | DiscordEmbed
Parameters
- type: EmbedType
Returns EmbedType | DiscordEmbed
- Defined in structures/DiscordEmbed.ts:20

setVideo

setVideo(options): EmbedVideo | DiscordEmbed
Parameters
- options: string | EmbedVideo
Returns EmbedVideo | DiscordEmbed
- Defined in structures/DiscordEmbed.ts:78

Class DiscordEmbed

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns DiscordEmbed

Properties

Optional author

Returns

Optional color

Returns

Optional description

Returns

Optional fields

Returns

Optional footer

Returns

Optional image

Returns

Optional provider

Returns

Optional thumbnail

Returns

Optional timestamp

Returns

Optional title

Returns

Optional type

Returns

Optional url

Returns

Optional video

Returns

Methods

setAuthor

Parameters

options: string | EmbedAuthor

Returns EmbedAuthor | DiscordEmbed

setColor

Parameters

color: number

Returns DiscordEmbed

setDescription

Parameters

description: string

Returns DiscordEmbed

setFields

Parameters

options: EmbedFooter[]

Returns DiscordEmbed | EmbedFooter[]

setFooter

Parameters

options: string | EmbedFooter

Returns EmbedFooter | DiscordEmbed

setImage

Parameters

options: string | EmbedImage

Returns EmbedImage | DiscordEmbed

setProvider

Parameters

options: EmbedProvider

Returns EmbedProvider | DiscordEmbed

setThumbnail

Parameters

options: string | EmbedThumbnail

Returns EmbedThumbnail | DiscordEmbed

setTimestamp

Parameters

Optional timestamp: string | number | Date

Returns DiscordEmbed

setTitle

Parameters

title: string

Returns DiscordEmbed

setType

Parameters

`Optional` author

`Optional` color

`Optional` description

`Optional` fields

`Optional` footer

`Optional` image

`Optional` provider

`Optional` thumbnail

`Optional` timestamp

`Optional` title

`Optional` type

`Optional` url

`Optional` video

`Optional` timestamp: string | number | Date