Documentation/detritus-client/Structures

MessageEmbedclass

Embed Structure, used for [Message] Structures

On this page

Overview
Constructor1
Properties16
Accessors13
Methods14

Embed Structure, used for [Message] Structures

import { Structures } from 'detritus-client';

Structures.MessageEmbed;

Hierarchy

StructureBaseStructureMessageEmbed

26 properties2 methods15 inheritedsrc/structures/messageembed.ts:35

Constructor

new MessageEmbed

src/structures/messageembed.ts:54

new MessageEmbed(client: ShardClient, data?: BaseStructureData, isClone?: boolean)

Properties

author?

MessageEmbedAuthor

optional

client

ShardClient

readonly

Inherited from BaseStructure.client

color?

number

optional

description?

string

optional

fields?

BaseCollection<number, MessageEmbedField>

optional

flags?

number

optional

image?

MessageEmbedImage

optional

provider?

MessageEmbedProvider

optional

referenceId?

string

optional

thumbnail?

MessageEmbedThumbnail

optional

timestamp?

Date

optional

title?

string

optional

type

MessageEmbedTypes

Default MessageEmbedTypes.RICH

url?

string

optional

video?

MessageEmbedVideo

optional

Accessors

hasAttachment

boolean

get

isApplicationNews

boolean

get

isArticle

boolean

get

isClone

boolean

get

Inherited from BaseStructure.isClone

isGifV

boolean

get

isImage

boolean

get

isLink

boolean

get

isRich

boolean

get

isTweet

boolean

get

isVideo

boolean

get

length

number

get

shardId

number

get

Inherited from BaseStructure.shardId

size

number

get

Methods

_getFromSnake()

src/structures/basestructure.ts:138

_getFromSnake(key: string): any

Inherited from BaseStructure._getFromSnake

_setFromSnake()

src/structures/basestructure.ts:142

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

Inherited from BaseStructure._setFromSnake

[custom]()

src/structures/basestructure.ts:388

[custom](): object

Inherited from BaseStructure.[custom]

clone()

src/structures/basestructure.ts:431

clone(): this

Inherited from BaseStructure.clone

difference()

src/structures/basestructure.ts:146

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

Inherited from BaseStructure.difference

differences()

src/structures/basestructure.ts:178

differences(data?: BaseStructureData): object | null

Inherited from BaseStructure.differences

differencesBetween()

src/structures/basestructure.ts:197

differencesBetween(structure: Structure): object | null

Inherited from BaseStructure.differencesBetween

fetchApplicationNews()

async src/structures/messageembed.ts:127

fetchApplicationNews(): Promise<ApplicationNews>

hasDifference()

src/structures/basestructure.ts:218

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

Inherited from BaseStructure.hasDifference

hasDifferences()

src/structures/basestructure.ts:293

hasDifferences(data?: BaseStructureData): boolean

Inherited from BaseStructure.hasDifferences

hasDifferencesBetween()

src/structures/basestructure.ts:308

hasDifferencesBetween(structure: Structure): boolean

Inherited from BaseStructure.hasDifferencesBetween

merge()

src/structures/messageembed.ts:137

merge(data?: BaseStructureData): void

Overrides BaseStructure.merge

mergeValue()

src/structures/basestructure.ts:351

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

Inherited from BaseStructure.mergeValue

toJSON()

src/structures/basestructure.ts:357

toJSON(): object

Inherited from BaseStructure.toJSON