Class MessageEmbed

Embed Structure, used for [Message] Structures

Hierarchy

BaseStructure
- MessageEmbed

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

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

Overrides BaseStructure.constructor
- Defined in src/structures/messageembed.ts:49
Parameters
- client: ShardClient
- Optional data: BaseStructureData
- Optional isClone: boolean
Returns MessageEmbed

Properties

Readonly _keys

_keys: BaseSet<string> = ...

Optional author

author: MessageEmbedAuthor

Readonly client

client: ShardClient

Optional color

color: number

Optional description

description: string

Optional fields

fields: BaseCollection<number, MessageEmbedField>

Optional footer

footer: MessageEmbedFooter

Optional image

image: MessageEmbedImage

Optional provider

provider: MessageEmbedProvider

Optional referenceId

referenceId: string

Optional thumbnail

thumbnail: MessageEmbedThumbnail

Optional timestamp

timestamp: Date

Optional title

title: string

type

type: MessageEmbedTypes = ...

Optional url

url: string

Optional video

video: MessageEmbedVideo

Accessors

hasAttachment

get hasAttachment(): boolean

- Defined in src/structures/messageembed.ts:60
Returns boolean

isApplicationNews

get isApplicationNews(): boolean

- Defined in src/structures/messageembed.ts:68
Returns boolean

isArticle

get isArticle(): boolean

- Defined in src/structures/messageembed.ts:72
Returns boolean

isClone

get isClone(): boolean

- Defined in src/structures/basestructure.ts:317
Returns boolean

isGifV

get isGifV(): boolean

- Defined in src/structures/messageembed.ts:76
Returns boolean

isImage

get isImage(): boolean

- Defined in src/structures/messageembed.ts:80
Returns boolean

isLink

get isLink(): boolean

- Defined in src/structures/messageembed.ts:84
Returns boolean

isRich

get isRich(): boolean

- Defined in src/structures/messageembed.ts:88
Returns boolean

isTweet

get isTweet(): boolean

- Defined in src/structures/messageembed.ts:92
Returns boolean

isVideo

get isVideo(): boolean

- Defined in src/structures/messageembed.ts:96
Returns boolean

length

get length(): number

- Defined in src/structures/messageembed.ts:100
Returns number

shardId

get shardId(): number

- Defined in src/structures/basestructure.ts:321
Returns number

size

get size(): number

- Defined in src/structures/messageembed.ts:104
Returns number

Methods

[custom]

[custom](): object

Inherited from BaseStructure.[custom]
- Defined in src/structures/basestructure.ts:282
Returns object

_getFromSnake

_getFromSnake(key: string): any

Inherited from BaseStructure._getFromSnake
- Defined in src/structures/basestructure.ts:33
Parameters
- key: string
Returns any

_setFromSnake

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

Inherited from BaseStructure._setFromSnake
- Defined in src/structures/basestructure.ts:37
Parameters
- key: string
- value: any
Returns any

clone

clone(): MessageEmbed

Inherited from BaseStructure.clone
- Defined in src/structures/basestructure.ts:325
Returns MessageEmbed

difference

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

Inherited from BaseStructure.difference
- Defined in src/structures/basestructure.ts:41
Parameters
- key: string
- value: any
Returns [boolean, any]

differences

differences(data?: BaseStructureData): null | object

Inherited from BaseStructure.differences
- Defined in src/structures/basestructure.ts:67
Parameters
- Optional data: BaseStructureData
Returns null | object

differencesBetween

differencesBetween(structure: Structure): null | object

Inherited from BaseStructure.differencesBetween
- Defined in src/structures/basestructure.ts:86
Parameters
- structure: Structure
Returns null | object

fetchApplicationNews

fetchApplicationNews(): Promise<ApplicationNews>

- Defined in src/structures/messageembed.ts:124
Returns Promise<ApplicationNews>

hasDifference

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

Inherited from BaseStructure.hasDifference
- Defined in src/structures/basestructure.ts:107
Parameters
- key: string
- value: any
Returns boolean

hasDifferences

hasDifferences(data?: BaseStructureData): boolean

Inherited from BaseStructure.hasDifferences
- Defined in src/structures/basestructure.ts:195
Parameters
- Optional data: BaseStructureData
Returns boolean

hasDifferencesBetween

hasDifferencesBetween(structure: Structure): boolean

Inherited from BaseStructure.hasDifferencesBetween
- Defined in src/structures/basestructure.ts:210
Parameters
- structure: Structure
Returns boolean

merge

merge(data?: BaseStructureData): void

Inherited from BaseStructure.merge
- Defined in src/structures/basestructure.ts:225
Parameters
- Optional data: BaseStructureData
Returns void

mergeValue

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

Overrides BaseStructure.mergeValue
- Defined in src/structures/messageembed.ts:134
Parameters
- key: string
- value: any
Returns void

toJSON

toJSON(): object

Inherited from BaseStructure.toJSON
- Defined in src/structures/basestructure.ts:259
Returns object

Generated using TypeDoc