Class InMessageEmbed

constructor

• new InMessageEmbed(data: APIEmbed): InMessageEmbed

  Parameters

  • data: APIEmbed

  Returns InMessageEmbed

data

author

• get author(): | {
      iconUrl?: string;
      name: string;
      proxyIconUrl?: string;
      url?: string;
  }
  | undefined

  Returns
      | {
          iconUrl?: string;
          name: string;
          proxyIconUrl?: string;
          url?: string;
      }
      | undefined

color

• get color(): number | undefined

  Returns number | undefined

description

• get description(): string | undefined

  Returns string | undefined

fields

• get fields(): APIEmbedField[] | undefined

  Returns APIEmbedField[] | undefined

footer

• get footer(): | { iconUrl?: string; proxyIconUrl?: string; text: string }
  | undefined

  Returns { iconUrl?: string; proxyIconUrl?: string; text: string } | undefined

image

• get image(): | {
      height?: number;
      proxyUrl?: string;
      url: string;
      width?: number;
  }
  | undefined

  Returns { height?: number; proxyUrl?: string; url: string; width?: number } | undefined

provider

• get provider(): APIEmbedProvider | undefined

  Returns APIEmbedProvider | undefined

thumbnail

• get thumbnail(): | {
      height?: number;
      proxyUrl?: string;
      url: string;
      width?: number;
  }
  | undefined

  Returns { height?: number; proxyUrl?: string; url: string; width?: number } | undefined

timestamp

• get timestamp(): string | undefined

  Returns string | undefined

title

• get title(): string | undefined

  Returns string | undefined

type

• get type(): EmbedType | undefined

  Returns EmbedType | undefined

url

• get url(): string | undefined

  Returns string | undefined

video

• get video(): | {
      height?: number;
      proxyUrl?: string;
      url?: string;
      width?: number;
  }
  | undefined

  Returns { height?: number; proxyUrl?: string; url?: string; width?: number } | undefined

toBuilder

• toBuilder(): Embed

  Returns Embed

toJSON

• toJSON(): {
      author?: APIEmbedAuthor;
      color?: number;
      description?: string;
      fields?: APIEmbedField[];
      footer?: APIEmbedFooter;
      image?: APIEmbedImage;
      provider?: APIEmbedProvider;
      thumbnail?: APIEmbedThumbnail;
      timestamp?: string;
      title?: string;
      type?: EmbedType;
      url?: string;
      video?: APIEmbedVideo;
  }

  Returns {
      author?: APIEmbedAuthor;
      color?: number;
      description?: string;
      fields?: APIEmbedField[];
      footer?: APIEmbedFooter;
      image?: APIEmbedImage;
      provider?: APIEmbedProvider;
      thumbnail?: APIEmbedThumbnail;
      timestamp?: string;
      title?: string;
      type?: EmbedType;
      url?: string;
      video?: APIEmbedVideo;
  }

  • Optionalauthor?: APIEmbedAuthor

    Author information

    See https://discord.com/developers/docs/resources/channel#embed-object-embed-author-structure

  • Optionalcolor?: number

    Color code of the embed

  • Optionaldescription?: string

    Description of embed

    Length limit: 4096 characters

  • Optionalfields?: APIEmbedField[]

    Fields information

    Length limit: 25 field objects

    See https://discord.com/developers/docs/resources/channel#embed-object-embed-field-structure

  • Optionalfooter?: APIEmbedFooter

    Footer information

    See https://discord.com/developers/docs/resources/channel#embed-object-embed-footer-structure

  • Optionalimage?: APIEmbedImage

    Image information

    See https://discord.com/developers/docs/resources/channel#embed-object-embed-image-structure

  • Optionalprovider?: APIEmbedProvider

    Provider information

    See https://discord.com/developers/docs/resources/channel#embed-object-embed-provider-structure

  • Optionalthumbnail?: APIEmbedThumbnail

    Thumbnail information

    See https://discord.com/developers/docs/resources/channel#embed-object-embed-thumbnail-structure

  • Optionaltimestamp?: string

    Timestamp of embed content

  • Optionaltitle?: string

    Title of embed

    Length limit: 256 characters

  • Optionaltype?: EmbedType

    Type of embed (always "rich" for webhook embeds)

    See https://discord.com/developers/docs/resources/channel#embed-object-embed-types

  • Optionalurl?: string

    URL of embed

  • Optionalvideo?: APIEmbedVideo

    Video information

    See https://discord.com/developers/docs/resources/channel#embed-object-embed-video-structure