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): MessageEmbed

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

Properties

_keys

_keys: BaseSet<string> = keysMessageEmbed

Optional author

author: MessageEmbedAuthor

client

client: ShardClient

Optional color

color: undefined | number

Optional description

description: undefined | string

Optional fields

fields: BaseCollection<number, MessageEmbedField>

Optional footer

footer: MessageEmbedFooter

Optional image

image: MessageEmbedImage

Optional provider

provider: MessageEmbedProvider

Optional referenceId

referenceId: undefined | string

Optional thumbnail

thumbnail: MessageEmbedThumbnail

Optional timestamp

timestamp: Date

Optional title

title: undefined | string

type

type: MessageEmbedTypes = MessageEmbedTypes.RICH

Optional url

url: undefined | string

Optional video

video: MessageEmbedVideo

Accessors

hasAttachment

get hasAttachment(): boolean

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

isApplicationNews

get isApplicationNews(): boolean

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

isArticle

get isArticle(): boolean

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

isGifV

get isGifV(): boolean

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

isImage

get isImage(): boolean

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

isLink

get isLink(): boolean

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

isRich

get isRich(): boolean

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

isTweet

get isTweet(): boolean

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

isVideo

get isVideo(): boolean

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

shardId

get shardId(): number

Inherited from BaseStructure.shardId
- Defined in src/structures/basestructure.ts:186
Returns number

Methods

[inspect.custom]

[inspect.custom](): object

Inherited from Structure.[inspect.custom]
- Defined in src/structures/basestructure.ts:160
Returns object

_getFromSnake

_getFromSnake(key: string): any

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

_setFromSnake

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

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

difference

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

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

differences

differences(data: BaseStructureData): null | object

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

fetchApplicationNews

fetchApplicationNews(): Promise<ApplicationNews>

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

merge

merge(data: BaseStructureData): void

Inherited from Structure.merge
- Defined in src/structures/basestructure.ts:119
Parameters
- data: BaseStructureData
Returns void

mergeValue

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

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

toJSON

toJSON(): object

Inherited from Structure.toJSON
- Defined in src/structures/basestructure.ts:150
Returns object

Generated using TypeDoc