Class Embed

Hierarchy

Embed

Index

Constructors

Properties

author color description fields footer image thumbnail timestamp timestampString title url video

Methods

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

Constructors

constructor

new Embed(data?): Embed
Parameters
- Optional data: Partial<ChatEmbedPayload>
Returns Embed
- Defined in guilded.js/lib/structures/Embed.ts:40

Properties

author

author: null | {
    iconURL: null | string;
    name: null | string;
    url: null | string;
}

color

color: null | number

description

description: null | string

fields

fields: {
    inline: null | boolean;
    name: string;
    value: string;
}[]

footer

footer: null | {
iconURL: null | string;
text: string;
}

image

image: null | APIEmbedMediaData

thumbnail

thumbnail: null | APIEmbedMediaData

timestamp

timestamp: null | number

`Private` timestampString

timestampString: null | string

title

title: null | string

url

url: null | string

video

video: null | APIEmbedMediaData

Methods

_update

_update(data): void
Parameters
- data: Partial<ChatEmbedPayload>
Returns void
- Defined in guilded.js/lib/structures/Embed.ts:57

addField

addField(name, value, inline?): Embed
Parameters
- name: string
- value: string
- Optional inline: boolean
Returns Embed
- Defined in guilded.js/lib/structures/Embed.ts:167

addFields

addFields(fields): Embed
Parameters
- fields: {
      inline?: boolean;
      name: string;
      value: string;
  }[]
Returns Embed
- Defined in guilded.js/lib/structures/Embed.ts:150

clearFields

clearFields(): Embed
Returns Embed
- Defined in guilded.js/lib/structures/Embed.ts:178

setAuthor

setAuthor(name?, iconURL?, url?): Embed
Parameters
- Optional name: string
- Optional iconURL: null | string
- Optional url: null | string
Returns Embed
- Defined in guilded.js/lib/structures/Embed.ts:139

setColor

setColor(color?): Embed
Parameters
- Optional color: null | string | number | [number, number, number]
Returns Embed
- Defined in guilded.js/lib/structures/Embed.ts:106

setDescription

setDescription(description?): Embed
Parameters
- Optional description: null | string
Returns Embed
- Defined in guilded.js/lib/structures/Embed.ts:75

setFooter

setFooter(text?, iconURL?): Embed
Parameters
- Optional text: string
- Optional iconURL: null | string
Returns Embed
- Defined in guilded.js/lib/structures/Embed.ts:111

setImage

setImage(url?): Embed
Parameters
- Optional url: string
Returns Embed
- Defined in guilded.js/lib/structures/Embed.ts:121

setThumbnail

setThumbnail(url?): Embed
Parameters
- Optional url: string
Returns Embed
- Defined in guilded.js/lib/structures/Embed.ts:130

setTimestamp

setTimestamp(timestamp?): Embed
Parameters
- Optional timestamp: null | string | number | Date
Returns Embed
- Defined in guilded.js/lib/structures/Embed.ts:85

setTitle

setTitle(title?): Embed
Parameters
- Optional title: null | string
Returns Embed
- Defined in guilded.js/lib/structures/Embed.ts:70

setURL

setURL(url?): Embed
Parameters
- Optional url: null | string
Returns Embed
- Defined in guilded.js/lib/structures/Embed.ts:80

toJSON

toJSON(): EmbedPayload
Returns EmbedPayload
- Defined in guilded.js/lib/structures/Embed.ts:183

Generated using TypeDoc