Class MessageBuilder

Hierarchy

MessageBuilder

Index

Constructors

Properties

Methods

addComponent addEmbed clearEmbeds removeEmbed toJSON

Constructors

constructor

new MessageBuilder(content?: string): MessageBuilder
Create a new MessageBuilder
Parameters
- Optional content: string
Returns MessageBuilder
- Defined in MessageBuilder.ts:23

Properties

data

data: {
    components: APIMessageComponent[];
    content?: string;
    embeds: APIEmbed[];
}

Type declaration

components: APIMessageComponent[]
Optional content?: string
embeds: APIEmbed[]

Methods

addComponent

addComponent(component: Button | APIMessageComponent): MessageBuilder
Add a component to the message

Returns
Parameters
- component: Button | APIMessageComponent
Returns MessageBuilder
- Defined in MessageBuilder.ts:70

addEmbed

addEmbed(embed: Embed | APIEmbed): MessageBuilder
Add an embed to the message

Returns
Parameters
- embed: Embed | APIEmbed
Returns MessageBuilder
- Defined in MessageBuilder.ts:37

clearEmbeds

clearEmbeds(): MessageBuilder
Remove all embeds from the message

Returns

Returns MessageBuilder
- Defined in MessageBuilder.ts:60

removeEmbed

removeEmbed(index: number): MessageBuilder
Remove an embed from the message

Returns
Parameters
- index: number
Returns MessageBuilder
- Defined in MessageBuilder.ts:51

toJSON

toJSON(): Object
Get the JSON representation of the message

Returns

Returns Object
- Defined in MessageBuilder.ts:83

Generated using TypeDoc