Embed

class Embed

A read-only embed from a received message. All properties are immutable copies of the Discord embed data.

Properties

Property

Type

Description

author

{ iconUrl: string | null; name: string; url: string | null; } | null

Author information, or null if not set.

color

number | null

24-bit RGB sidebar color, or null if not set.

description

string | null

Description text, or null if not set.

fields

{ inline: boolean; name: string; value: string; }[]

Array of field objects displayed in the embed body.

footer

{ iconUrl: string | null; text: string; } | null

Footer information, or null if not set.

image

{ height: number | null; proxyUrl: string | null; url: string; width: number | null; } | null

Main image, or null if not set.

thumbnail

{ height: number | null; proxyUrl: string | null; url: string; width: number | null; } | null

Thumbnail image, or null if not set.

timestamp

Date | null

ISO-8601 timestamp displayed in the footer, or null if not set.

title

string | null

Title of the embed, or null if not set.

url

string | null

URL the title links to, or null if not set.