MessageParams

Implementation of discords MessageParams object as a Luau builder.

https://discord.com/developers/docs/resources/channel#start-thread-in-forum-or-media-channel-forum-and-media-thread-message-params-object

Summary

Properties

MessageParams.content :: string?MessageParams.embeds :: { Builders.Embed }MessageParams.allowedMentions :: Builders.Message.AllowedMentionMessageParams.components :: { Builders.Message.Button | Builders.Message.TextInput | Builders.Message.SelectMenu | Builders.Message.ActionRow }MessageParams.stickerIds :: { string }MessageParams.attachments :: { Builders.Attachment }MessageParams.flags :: number?

Methods

MessageParams:setContent(content: string) → MessageParamsMessageParams:addEmbed(embedData: embed.JSON) → MessageParamsMessageParams:setAllowedMentions(mentions: allowedMention.JSON) → MessageParamsMessageParams:addComponent(component: button.JSON | textInput.JSON | selectMenu.JSON | actionRow.JSON) → MessageParamsMessageParams:addStickerId(stickerId: string) → MessageParamsMessageParams:addAttachment(attachmentData: attachment.JSON) → MessageParamsMessageParams:setFlags(flags: number) → MessageParamsMessageParams:build() → JSON

Functions

MessageParams.new(resource: { content: string?, embeds: { embed.JSON }?, allowedMentions: allowedMention.JSON?, components: { button.JSON | textInput.JSON | selectMenu.JSON | actionRow.JSON }?, stickerIds: { string }?, attachments: { attachment.JSON }?, flags: number?, }?) → MessageParams

Properties

content

MessageParams.content  :: string?

---

The message content that will be sent.

embeds

MessageParams.embeds  :: Embed }

---

Array of embed objects that will be attached to the message.

allowedMentions

MessageParams.allowedMentions  :: AllowedMention

---

Controls the mentions that will ping in the message.

components

MessageParams.components  :: ActionRow }

---

Array of message components that will be attached to the message.

stickerIds

MessageParams.stickerIds  :: { string }

---

Array of sticker IDs that will be attached to the message.

attachments

MessageParams.attachments  :: Attachment }

---

Array of attachment objects that will be attached to the message.

flags

MessageParams.flags  :: number?

---

Message flags to be applied to the message.

Methods

setContent

MessageParams : setContent ( content )  -> MessageParams

Sets the content of the message.

Parameters

content: string

Returns

MessageParams

addEmbed

MessageParams : addEmbed ( embedData )  -> MessageParams

Adds an embed to the message.

Parameters

embedData: JSON

Returns

MessageParams

setAllowedMentions

MessageParams : setAllowedMentions ( mentions )  -> MessageParams

Sets the allowed mentions for the message.

Parameters

mentions: JSON

Returns

MessageParams

addComponent

MessageParams : addComponent ( component )  -> MessageParams

Adds a component to the message.

Parameters

component: JSON

Returns

MessageParams

addStickerId

MessageParams : addStickerId ( stickerId )  -> MessageParams

Adds a sticker ID to the message.

Parameters

stickerId: string

Returns

MessageParams

addAttachment

MessageParams : addAttachment ( attachmentData )  -> MessageParams

Adds an attachment to the message.

Parameters

attachmentData: JSON

Returns

MessageParams

setFlags

MessageParams : setFlags ( flags )  -> MessageParams

Sets the flags for the message.

Parameters

flags: number

Returns

MessageParams

build

MessageParams : build ( )  -> JSON

Responsible for building the MessageParams JSON that can be parsed by the Discord API.

Returns

JSON

Functions

new

MessageParams . new ( resource )  -> MessageParams

Responsible for creating a new MessageParams.

Parameters

resource: { content: string?, embeds: { embed.JSON, }

Returns

MessageParams