Class Embed

Hierarchy

Embed

Index

Constructors

Properties

author? color? description? fields footer? image? thumbnail? timestamp? title? url?

Methods

addField addFields setAuthor setColor setDescription setFooter setImage setThumbnail setTimestamp setTitle setURL toJSON

Constructors

constructor

new Embed(data?: APIEmbed): Embed
Create a new Embed

Since
1.0.0
Parameters
- Optional data: APIEmbed
Returns Embed
- Defined in builders/Embed.ts:30

Properties

`Optional` author

author?: APIEmbedAuthor

`Optional` color

color?: number

`Optional` description

description?: string

fields

fields: APIEmbedField[]

`Optional` footer

footer?: APIEmbedFooter

`Optional` image

image?: APIEmbedImage

`Optional` thumbnail

thumbnail?: APIEmbedThumbnail

`Optional` timestamp

timestamp?: string | Date

`Optional` title

title?: string

`Optional` url

url?: string

Methods

addField

addField(name: string | any[], value: string | any[], inline?: boolean): Embed
Add a field to embed

Returns
Parameters
- name: string | any[]
- value: string | any[]
- Optional inline: boolean
Returns Embed
- Defined in builders/Embed.ts:267

addFields

addFields(fields: APIEmbedField[]): Embed
Add multiple fields to an embed
Parameters
- fields: APIEmbedField[]
Returns Embed
- Defined in builders/Embed.ts:304

setAuthor

setAuthor(name: string | any[], url: undefined | string, iconURL: undefined | string): Embed
Set the embed author

Returns
Parameters
- name: string | any[]
- url: undefined | string
- iconURL: undefined | string
Returns Embed
- Defined in builders/Embed.ts:242

setColor

setColor(color: string | number): Embed
Set The Embed Color

Returns
Parameters
- color: string | number
Returns Embed
- Defined in builders/Embed.ts:111

setDescription

setDescription(description: string): Embed
Set the Embed Description

Returns
Parameters
- description: string
Returns Embed
- Defined in builders/Embed.ts:93

setFooter

setFooter(iconURL: undefined | string, text: string | any[]): Embed
Set The embed footer

Returns
Parameters
- iconURL: undefined | string
- text: string | any[]
Returns Embed
- Defined in builders/Embed.ts:174

setImage

setImage(imageURL: string): Embed
Set The Embed Image

Returns
Parameters
- imageURL: string
Returns Embed
- Defined in builders/Embed.ts:208

setThumbnail

setThumbnail(url: string): Embed
Set the embed thumbnail

Returns
Parameters
- url: string
Returns Embed
- Defined in builders/Embed.ts:226

setTimestamp

setTimestamp(timestamp?: Date): Embed
Set The Embed Timestamp

Returns
Parameters
- timestamp: Date = ...
Returns Embed
- Defined in builders/Embed.ts:159

setTitle

setTitle(title: string): Embed
Set the Embed Title

Returns
Parameters
- title: string
Returns Embed
- Defined in builders/Embed.ts:75

setURL

setURL(url: string): Embed
Set The Embed URL

Returns
Parameters
- url: string
Returns Embed
- Defined in builders/Embed.ts:141

toJSON

toJSON(): {
    color: undefined | number;
    description: undefined | string;
    footer: undefined | APIEmbedFooter;
    image: undefined | APIEmbedImage;
    thumbnail: undefined | APIEmbedThumbnail;
    timestamp: undefined | string;
    title: undefined | string;
    url: undefined | string;
}
Convert the embed to a JSON object

Returns {
    color: undefined | number;
    description: undefined | string;
    footer: undefined | APIEmbedFooter;
    image: undefined | APIEmbedImage;
    thumbnail: undefined | APIEmbedThumbnail;
    timestamp: undefined | string;
    title: undefined | string;
    url: undefined | string;
}
- color: undefined | number
- description: undefined | string
- footer: undefined | APIEmbedFooter
- image: undefined | APIEmbedImage
- thumbnail: undefined | APIEmbedThumbnail
- timestamp: undefined | string
- title: undefined | string
- url: undefined | string
- Defined in builders/Embed.ts:314

Generated using TypeDoc