Embedclass

Utils Embed Structure

On this page

Overview
Constructor1
Properties14
Accessors2
Methods22

Utils Embed Structure

import { Utils } from 'detritus-client';

Utils.Embed;

Hierarchy

StructureEmbed

16 properties12 methods10 inheritedsrc/utils/embed.ts:29

Constructor

new Embed

src/utils/embed.ts:47

new Embed(data?: RawMessageEmbed)

Properties

author?

EmbedAuthor

optional

color?

number

optional

description?

string

optional

fields?

BaseCollection<number, EmbedField>

optional

image?

EmbedImage

optional

provider?

EmbedProvider

optional

referenceId?

string

optional

thumbnail?

EmbedThumbnail

optional

timestamp?

Date

optional

title?

string

optional

type

string

Default MessageEmbedTypes.RICH

url?

string

optional

video?

EmbedVideo

optional

Accessors

length

number

get

size

number

get

Methods

_getFromSnake()

src/structures/basestructure.ts:138

_getFromSnake(key: string): any

Inherited from Structure._getFromSnake

_setFromSnake()

src/structures/basestructure.ts:142

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

Inherited from Structure._setFromSnake

[custom]()

src/structures/basestructure.ts:388

[custom](): object

Inherited from Structure.[custom]

addField()

src/utils/embed.ts:76

addField(name: string, value: string, inline?: boolean): Embed

difference()

src/structures/basestructure.ts:146

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

Inherited from Structure.difference

differences()

src/structures/basestructure.ts:178

differences(data?: BaseStructureData): object | null

Inherited from Structure.differences

differencesBetween()

src/structures/basestructure.ts:197

differencesBetween(structure: Structure): object | null

Inherited from Structure.differencesBetween

hasDifference()

src/structures/basestructure.ts:218

hasDifference(key: string, value: any): boolean

Inherited from Structure.hasDifference

hasDifferences()

src/structures/basestructure.ts:293

hasDifferences(data?: BaseStructureData): boolean

Inherited from Structure.hasDifferences

hasDifferencesBetween()

src/structures/basestructure.ts:308

hasDifferencesBetween(structure: Structure): boolean

Inherited from Structure.hasDifferencesBetween

merge()

src/structures/basestructure.ts:323

merge(data?: BaseStructureData): void

Inherited from Structure.merge

mergeValue()

src/utils/embed.ts:159

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

Overrides Structure.mergeValue

setAuthor()

src/utils/embed.ts:85

setAuthor(name?: string | null, iconUrl?: string | null, url?: string | null): Embed

setColor()

src/utils/embed.ts:100

setColor(color: number): Embed

setDescription()

src/utils/embed.ts:105

setDescription(description: string | null): Embed

setFooter()

src/utils/embed.ts:110

setFooter(text: string, iconUrl?: string | null): Embed

setImage()

src/utils/embed.ts:123

setImage(url: string): Embed

setThumbnail()

src/utils/embed.ts:130

setThumbnail(url: string): Embed

setTimestamp()

src/utils/embed.ts:137

setTimestamp(timestamp?: string | number | Date): Embed

setTitle()

src/utils/embed.ts:149

setTitle(title: string): Embed

setUrl()

src/utils/embed.ts:154

setUrl(url: string): Embed

toJSON()

src/utils/embed.ts:245

toJSON(): RawMessageEmbed

Overrides Structure.toJSON