Class WebsiteEmbed

Website Embed

Hierarchy

Constructors

constructor

Properties

client? colour? description? iconUrl? image? originalUrl? siteName? specialContent? title? type url? video?

Accessors

embedURL proxiedIconURL

Methods

from

Constructors

constructor

Properties

Protected Optional client

client?: Client

Optional Readonly colour

colour?: string

Optional Readonly description

description?: string

Optional Readonly iconUrl

iconUrl?: string

Optional Readonly image

image?: ImageEmbed

Optional Readonly originalUrl

originalUrl?: string

Optional Readonly siteName

siteName?: string

Optional Readonly specialContent

specialContent?: {
    type: "None";
} | {
    type: "GIF";
} | {
    id: string;
    timestamp?: null | string;
    type: "YouTube";
} | {
    content_type: "Channel";
    id: string;
    type: "Lightspeed";
} | {
    content_type: "Channel" | "Video" | "Clip";
    id: string;
    type: "Twitch";
} | {
    content_type: string;
    id: string;
    type: "Spotify";
} | {
    type: "Soundcloud";
} | {
    content_type: "Album" | "Track";
    id: string;
    type: "Bandcamp";
} | {
    id: string;
    type: "Streamable";
}

Optional Readonly title

title?: string

Readonly type

type: "None" | "Website" | "Image" | "Video" | "Text"

Optional Readonly url

url?: string

Optional Readonly video

video?: VideoEmbed

Accessors

embedURL

  • get embedURL(): undefined | string

  • If special content is present, generate the embed URL

    Returns undefined | string

proxiedIconURL

Methods

Static from

  • Create an Embed from an API Embed

    Returns

    Embed

    Parameters

    • client: Client

      Client

    • embed: {
          colour?: null | string;
          description?: null | string;
          icon_url?: null | string;
          image?: null | {
              height: number;
              size: "Large" | "Preview";
              url: string;
              width: number;
          };
          original_url?: null | string;
          site_name?: null | string;
          special?: null | {
              type: "None";
          } | {
              type: "GIF";
          } | {
              id: string;
              timestamp?: null | string;
              type: "YouTube";
          } | {
              content_type: "Channel";
              id: string;
              type: "Lightspeed";
          } | {
              content_type: "Channel" | "Video" | "Clip";
              id: string;
              type: "Twitch";
          } | {
              content_type: string;
              id: string;
              type: "Spotify";
          } | {
              type: "Soundcloud";
          } | {
              content_type: "Album" | "Track";
              id: string;
              type: "Bandcamp";
          } | {
              id: string;
              type: "Streamable";
          };
          title?: null | string;
          type: "Website";
          url?: null | string;
          video?: null | {
              height: number;
              url: string;
              width: number;
          };
      } | {
          height: number;
          size: "Large" | "Preview";
          type: "Image";
          url: string;
          width: number;
      } | {
          height: number;
          type: "Video";
          url: string;
          width: number;
      } | {
          colour?: null | string;
          description?: null | string;
          icon_url?: null | string;
          media?: null | {
              _id: string;
              content_type: string;
              deleted?: null | boolean;
              filename: string;
              message_id?: null | string;
              metadata: {
                  type: "File";
              } | {
                  type: "Text";
              } | {
                  height: number;
                  type: "Image";
                  width: number;
              } | {
                  height: number;
                  type: "Video";
                  width: number;
              } | {
                  type: "Audio";
              };
              object_id?: null | string;
              reported?: null | boolean;
              server_id?: null | string;
              size: number;
              tag: string;
              user_id?: null | string;
          };
          title?: null | string;
          type: "Text";
          url?: null | string;
      } | {
          type: "None";
      }

      Data

    Returns MessageEmbed

On This Page

Generated using TypeDoc