Class WebsiteEmbed

Website Embed

Hierarchy (View Summary)

MessageEmbed
- WebsiteEmbed

Index

Constructors

constructor

new WebsiteEmbed(
    client: Client,
    embed: Omit<
        (
            | {
                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: "Video" | "Channel" | "Clip";
                        id: string;
                        type: "Twitch";
                    }
                    | { content_type: string; id: string; type: "Spotify" }
                    | { type: "Soundcloud" }
                    | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                    | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                    | { 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" }
        ) & { type: "Website" },
        "type",
    >,
): WebsiteEmbed
Construct Video Embed
Parameters
- client: Client
  Client
- embed: Omit<
      (
          | {
              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: "Video" | "Channel" | "Clip";
                      id: string;
                      type: "Twitch";
                  }
                  | { content_type: string; id: string; type: "Spotify" }
                  | { type: "Soundcloud" }
                  | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                  | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                  | { 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" }
      ) & { type: "Website" },
      "type",
  >
  Embed
Returns WebsiteEmbed
Overrides MessageEmbed.constructor
- Defined in src/classes/MessageEmbed.ts:131

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: "Video" | "Channel" | "Clip";
        id: string;
        type: "Twitch";
    }
    | { content_type: string; id: string; type: "Spotify" }
    | { type: "Soundcloud" }
    | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
    | { album_id: string; track_id?: null | string; type: "AppleMusic" }
    | { id: string; type: "Streamable" }

`Optional` `Readonly`title

title?: string

`Readonly`type

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

`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
- Defined in src/classes/MessageEmbed.ts:159

proxiedIconURL

get proxiedIconURL(): undefined | string
Proxied icon URL

Returns undefined | string
- Defined in src/classes/MessageEmbed.ts:152

Methods

`Static`from

from(
    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: "Video" | "Channel" | "Clip";
                    id: string;
                    type: "Twitch";
                }
                | { content_type: string; id: string; type: "Spotify" }
                | { type: "Soundcloud" }
                | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                | { 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" },
): MessageEmbed
Create an Embed from an API 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: "Video" | "Channel" | "Clip";
                  id: string;
                  type: "Twitch";
              }
              | { content_type: string; id: string; type: "Spotify" }
              | { type: "Soundcloud" }
              | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
              | { album_id: string; track_id?: null | string; type: "AppleMusic" }
              | { 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
  - {
        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: "Video" | "Channel" | "Clip";
                id: string;
                type: "Twitch";
            }
            | { content_type: string; id: string; type: "Spotify" }
            | { type: "Soundcloud" }
            | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
            | { album_id: string; track_id?: null | string; type: "AppleMusic" }
            | { id: string; type: "Streamable" };
        title?: null | string;
        type: "Website";
        url?: null | string;
        video?: null | { height: number; url: string; width: number };
    }
    Optionalcolour?: null | string
    Description
    CSS Colour
    
    Optionaldescription?: null | string
    Description
    Description of website
    
    Optionalicon_url?: null | string
    Description
    URL to site icon
    
    Optionalimage?: null | { height: number; size: "Large" | "Preview"; url: string; width: number }
    Description
    Embedded image
    
    Optionaloriginal_url?: null | string
    Description
    Original direct URL
    
    Optionalsite_name?: null | string
    Description
    Site name
    
    Optionalspecial?:
        | null
        | { type: "None" }
        | { type: "GIF" }
        | { id: string; timestamp?: null | string; type: "YouTube" }
        | { content_type: "Channel"; id: string; type: "Lightspeed" }
        | {
            content_type: "Video" | "Channel" | "Clip";
            id: string;
            type: "Twitch";
        }
        | { content_type: string; id: string; type: "Spotify" }
        | { type: "Soundcloud" }
        | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
        | { album_id: string; track_id?: null | string; type: "AppleMusic" }
        | { id: string; type: "Streamable" }
    Description
    Remote content
    
    Optionaltitle?: null | string
    Description
    Title of website
    
    type: "Website"
    Optionalurl?: null | string
    Description
    Direct URL to web page
    
    Optionalvideo?: null | { height: number; url: string; width: number }
    Description
    Embedded video
  - {
        height: number;
        size: "Large" | "Preview";
        type: "Image";
        url: string;
        width: number;
    }
    height: number
    Format: uint
    
    Description
    Height of the image
    
    size: "Large" | "Preview"
    Description
    Positioning and size
    
    type: "Image"
    url: string
    Description
    URL to the original image
    
    width: number
    Format: uint
    
    Description
    Width of the image
  - { height: number; type: "Video"; url: string; width: number }
    height: number
    Format: uint
    
    Description
    Height of the video
    
    type: "Video"
    url: string
    Description
    URL to the original video
    
    width: number
    Format: uint
    
    Description
    Width of the video
  - {
        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;
    }
    Optionalcolour?: null | string
    Description
    CSS Colour
    
    Optionaldescription?: null | string
    Description
    Description of text embed
    
    Optionalicon_url?: null | string
    Description
    URL to icon
    
    Optionalmedia?:
        | 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;
        }
    Description
    ID of uploaded autumn file
    
    Optionaltitle?: null | string
    Description
    Title of text embed
    
    type: "Text"
    Optionalurl?: null | string
    Description
    URL for title
  - { type: "None" }
Returns MessageEmbed
Embed
Inherited from MessageEmbed.from
- Defined in src/classes/MessageEmbed.ts:30

Class WebsiteEmbed

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WebsiteEmbed

Properties

Protected Optionalclient

Optional Readonlycolour

Optional Readonlydescription

Optional ReadonlyiconUrl

Optional Readonlyimage

Optional ReadonlyoriginalUrl

Optional ReadonlysiteName

Optional ReadonlyspecialContent

Optional Readonlytitle

Readonlytype

Optional Readonlyurl

Optional Readonlyvideo

Accessors

embedURL

Returns undefined | string

proxiedIconURL

Returns undefined | string

Methods

Staticfrom

Parameters

Optionalcolour?: null | string

Description

Optionaldescription?: null | string

Description

Optionalicon_url?: null | string

Description

Optionalimage?: null | { height: number; size: "Large" | "Preview"; url: string; width: number }

Description

Optionaloriginal_url?: null | string

Description

Optionalsite_name?: null | string

Description

Description

Optionaltitle?: null | string

Description

type: "Website"

Optionalurl?: null | string

Description

Optionalvideo?: null | { height: number; url: string; width: number }

Description

height: number

Description

size: "Large" | "Preview"

Description

type: "Image"

url: string

Description

width: number

Description

height: number

Description

type: "Video"

url: string

Description

width: number

Description

Optionalcolour?: null | string

Description

Optionaldescription?: null | string

Description

Optionalicon_url?: null | string

Description

Description

Optionaltitle?: null | string

Description

type: "Text"

Optionalurl?: null | string

Description

`Protected` `Optional`client

`Optional` `Readonly`colour

`Optional` `Readonly`description

`Optional` `Readonly`iconUrl

`Optional` `Readonly`image

`Optional` `Readonly`originalUrl

`Optional` `Readonly`siteName

`Optional` `Readonly`specialContent

`Optional` `Readonly`title

`Readonly`type

`Optional` `Readonly`url

`Optional` `Readonly`video

`Static`from

`Optional`colour?: null | string

`Optional`description?: null | string

`Optional`icon_url?: null | string

`Optional`image?: null | { height: number; size: "Large" | "Preview"; url: string; width: number }

`Optional`original_url?: null | string

`Optional`site_name?: null | string

`Optional`title?: null | string

`Optional`url?: null | string

`Optional`video?: null | { height: number; url: string; width: number }

`Optional`colour?: null | string

`Optional`description?: null | string

`Optional`icon_url?: null | string

`Optional`title?: null | string

`Optional`url?: null | string