Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MessageEmbed

Embed Structure, used for [Message] Structures

Hierarchy

Index

Constructors

constructor

Properties

_keys

_keys: BaseSet<string> = keysMessageEmbed

Optional author

client

client: ShardClient

Optional color

color: undefined | number

Optional description

description: undefined | string

Optional fields

fields: BaseCollection<number, MessageEmbedField>

Optional footer

Optional image

Optional provider

Optional referenceId

referenceId: undefined | string

Optional thumbnail

Optional timestamp

timestamp: Date

Optional title

title: undefined | string

type

type: MessageEmbedTypes = MessageEmbedTypes.RICH

Optional url

url: undefined | string

Optional video

Accessors

hasAttachment

  • get hasAttachment(): boolean
  • Returns boolean

isApplicationNews

  • get isApplicationNews(): boolean
  • Returns boolean

isArticle

  • get isArticle(): boolean
  • Returns boolean

isGifV

  • get isGifV(): boolean
  • Returns boolean

isImage

  • get isImage(): boolean
  • Returns boolean

isLink

  • get isLink(): boolean
  • Returns boolean

isRich

  • get isRich(): boolean
  • Returns boolean

isTweet

  • get isTweet(): boolean
  • Returns boolean

isVideo

  • get isVideo(): boolean
  • Returns boolean

shardId

  • get shardId(): number
  • Returns number

Methods

[inspect.custom]

  • [inspect.custom](): object

_getFromSnake

  • _getFromSnake(key: string): any
  • Parameters

    • key: string

    Returns any

_setFromSnake

  • _setFromSnake(key: string, value: any): any
  • Parameters

    • key: string
    • value: any

    Returns any

difference

  • difference(key: string, value: any): [boolean, any]
  • Parameters

    • key: string
    • value: any

    Returns [boolean, any]

differences

fetchApplicationNews

  • Returns Promise<ApplicationNews>

merge

mergeValue

  • mergeValue(key: string, value: any): void
  • Parameters

    • key: string
    • value: any

    Returns void

toJSON

  • toJSON(): object
  • Returns object

Generated using TypeDoc