Class Embed

Hierarchy

Embed

Index

Constructors

Methods

addField setAuthor setColor setDescription setFields setFooter setImage setProvider setThumbnail setTimestamp setTitle setUrl setVideo toObject

Constructors

constructor

new Embed(): Embed
Returns Embed

Methods

addField

addField(field: IField): Embed
Set Field information Maximum 25 fields

Returns
this
Parameters
- field: IField
  
  Field
Returns Embed
- Defined in Classes/Embed.ts:212

setAuthor

setAuthor(author: IAuthor): Embed
Set Author information

Returns
this
Parameters
- author: IAuthor
  
  Author
Returns Embed
- Defined in Classes/Embed.ts:200

setColor

setColor(color: string | number): Embed
Set color code of the embed.

Returns
this
Parameters
- color: string | number
  
  number | string
Returns Embed
- Defined in Classes/Embed.ts:131

setDescription

setDescription(description: string): Embed
Description of the embed.

Returns
Embed
Parameters
- description: string
  
  string
Returns Embed
- Defined in Classes/Embed.ts:110

setFields

setFields(fields: IField[]): Embed
Set bulk field information. Maximum 25 fields

Returns
Embed
Parameters
- fields: IField[]
  
  Array
Returns Embed
- Defined in Classes/Embed.ts:226

setFooter

setFooter(footer: IFooter): Embed
Set Footer information.

Returns
this
Parameters
- footer: IFooter
  
  Footer
Returns Embed
- Defined in Classes/Embed.ts:145

setImage

setImage(image: IImage): Embed
Set Image information

Returns
this
Parameters
- image: IImage
  
  Image
Returns Embed
- Defined in Classes/Embed.ts:156

setProvider

setProvider(provider: IProvider): Embed
Set Provider information

Returns
this
Parameters
- provider: IProvider
  
  Provider
Returns Embed
- Defined in Classes/Embed.ts:189

setThumbnail

setThumbnail(thumbnail: IThumbnail): Embed
Set Thumbnail information

Returns
this
Parameters
- thumbnail: IThumbnail
  
  Thumbnail
Returns Embed
- Defined in Classes/Embed.ts:167

setTimestamp

setTimestamp(): Embed
Set ISO8601 timestamp of the embed content.

Returns
this

Returns Embed
- Defined in Classes/Embed.ts:120

setTitle

setTitle(title: string): Embed
Set Title of the embed.

Returns
this
Parameters
- title: string
  
  string
Returns Embed
- Defined in Classes/Embed.ts:88

setUrl

setUrl(url: string): Embed
Set URL of embed.

Returns
this
Parameters
- url: string
  
  string
Returns Embed
- Defined in Classes/Embed.ts:99

setVideo

setVideo(video: IVideo): Embed
Set Video information

Returns
this
Parameters
- video: IVideo
  
  Video
Returns Embed
- Defined in Classes/Embed.ts:178

toObject

toObject(): IEmbed
Generate object based on input

Returns
IEmbed

Returns IEmbed
- Defined in Classes/Embed.ts:237

Generated using TypeDoc