stoatbot.js
    Preparing search index...

    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 toJSONWithMedia

    Constructors

    Methods

    • Sets the media (e.g., image or video) of the embed.

      Parameters

      • media: string | Readable | File

        The media URL, File or Stream to set.

      Returns this

      The updated MessageEmbed instance.

    • Converts the embed to a JSON object that can be sent to the API.

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

      The JSON representation of the embed.

    • Parameters

      • client: client

        The client instance used to send the embed.

      Returns Promise<
          {
              colour?: string
              | null;
              description?: string | null;
              icon_url?: string | null;
              media?: string | null;
              title?: string | null;
              url?: string | null;
          },
      >

      SendableEmbed Converts the embed to a JSON object that can be sent to the API, including media handling.

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods