Class MessageEmbed

Represents a message embed, which can include rich content such as titles, descriptions, URLs, and media.

Index

Constructors

constructor

Methods

setColor setDescription setIcon setMedia setTitle setURL toJSON

Constructors

constructor

new MessageEmbed(): MessageEmbed
Returns MessageEmbed

Methods

setColor

setColor(color: string): this
Sets the color of the embed.
Parameters
- color: string
  The color to set (e.g., a hex code).
Returns this
The updated MessageEmbed instance.
- Defined in work/revbot.js/revbot.js/src/struct/messageEmbed.ts:47

setDescription

setDescription(description: string): this
Sets the description of the embed.
Parameters
- description: string
  The description to set.
Returns this
The updated MessageEmbed instance.
- Defined in work/revbot.js/revbot.js/src/struct/messageEmbed.ts:58

setIcon

setIcon(iconURL: string): this
Sets the icon URL of the embed.
Parameters
- iconURL: string
  The URL of the icon to set.
Returns this
The updated MessageEmbed instance.
- Defined in work/revbot.js/revbot.js/src/struct/messageEmbed.ts:36

setMedia

setMedia(media: string): this
Sets the media (e.g., image or video) of the embed.
Parameters
- media: string
  The media URL to set.
Returns this
The updated MessageEmbed instance.
- Defined in work/revbot.js/revbot.js/src/struct/messageEmbed.ts:80

setTitle

setTitle(title: string): this
Sets the title of the embed.
Parameters
- title: string
  The title to set.
Returns this
The updated MessageEmbed instance.
- Defined in work/revbot.js/revbot.js/src/struct/messageEmbed.ts:25

setURL

setURL(url: string): this
Sets the URL of the embed.
Parameters
- url: string
  The URL to set.
Returns this
The updated MessageEmbed instance.
- Defined in work/revbot.js/revbot.js/src/struct/messageEmbed.ts:69

toJSON

toJSON(): {
    colour?: null
    | string;
    description?: null | string;
    icon_url?: null | string;
    media?: null | string;
    title?: null | string;
    url?: null | string;
}
Converts the embed to a JSON object that can be sent to the API.

Returns {
    colour?: null | string;
    description?: null | string;
    icon_url?: null | string;
    media?: null | string;
    title?: null | string;
    url?: null | string;
}
The JSON representation of the embed.
- Defined in work/revbot.js/revbot.js/src/struct/messageEmbed.ts:90

Class MessageEmbed

Index

Constructors

Methods

Constructors

constructor

Returns MessageEmbed

Methods

setColor

Parameters

Returns this

setDescription

Parameters

Returns this

setIcon

Parameters

Returns this

setMedia

Parameters

Returns this

setTitle

Parameters

Returns this

setURL

Parameters

Returns this

toJSON

Returns {
    colour?: null | string;
    description?: null | string;
    icon_url?: null | string;
    media?: null | string;
    title?: null | string;
    url?: null | string;
}

Settings

On This Page

Class MessageEmbed

Index

Constructors

Methods

Constructors

constructor

Returns MessageEmbed

Methods

setColor

Parameters

Returns this

setDescription

Parameters

Returns this

setIcon

Parameters

Returns this

setMedia

Parameters

Returns this

setTitle

Parameters

Returns this

setURL

Parameters

Returns this

toJSON

Returns { colour?: null | string; description?: null | string; icon_url?: null | string; media?: null | string; title?: null | string; url?: null | string;}

Settings

On This Page

Returns {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
media?: null | string;
title?: null | string;
url?: null | string;
}