ODMessageInstance class

under construction

We are still working the API Reference! This page might be incomplete or doesn't contain all details!

Overview

This is an Open Ticket message instance.

It contains all properties & functions to build a message!

View Source

Properties

• data

Methods

• constructor
• addComponent
• addEmbed
• addFile
• getComponent
• getEmbed
• getFile
• removeComponent
• removeEmbed
• removeFile
• setComponents
• setContent
• setEmbeds
• setEphemeral
• setFiles
• setPoll

Other

• Open Ticket Defaults
• Plugin Defaults
• Examples

Properties

---

data interface ➜ api.ODMessageData

The current data of this message

View Source

---

Methods

---

constructor() function ➜ api.ODMessageInstance

(no description)

View Source

---

addComponent() function ➜ api.ODMessageInstance

Add a component to this message!

View Parameters (1)

• component: interface ➜ api.ODComponentBuildResult - Parameter Description Lorem Ipsum.

View Source

---

addEmbed() function ➜ api.ODMessageInstance

Add an embed to this message!

View Parameters (1)

• embed: interface ➜ api.ODEmbedBuildResult - Parameter Description Lorem Ipsum.

View Source

---

addFile() function ➜ api.ODMessageInstance

Add a file to this message!

View Parameters (1)

• file: interface ➜ api.ODFileBuildResult - Parameter Description Lorem Ipsum.

View Source

---

getComponent() function ➜ null|"\n"|discord.MessageActionRowComponentBuilder

Get a component from this message

View Parameters (1)

• id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.

View Source

---

getEmbed() function ➜ null|discord.EmbedBuilder

Get an embed from this message

View Parameters (1)

• id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.

View Source

---

getFile() function ➜ null|discord.AttachmentBuilder

Get a file from this message

View Parameters (1)

• id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.

View Source

---

removeComponent() function ➜ api.ODMessageInstance

Remove a component from this message

View Parameters (1)

• id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.

View Source

---

removeEmbed() function ➜ api.ODMessageInstance

Remove an embed from this message

View Parameters (1)

• id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.

View Source

---

removeFile() function ➜ api.ODMessageInstance

Remove a file from this message

View Parameters (1)

• id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.

View Source

---

setComponents() function ➜ api.ODMessageInstance

Set the components of this message

View Parameters (1)

• components: array ➜ api.ODComponentBuildResult[] - Parameter Description Lorem Ipsum.

View Source

---

setContent() function ➜ api.ODMessageInstance

Set the content of this message

View Parameters (1)

• content: type ➜ null|string - Parameter Description Lorem Ipsum.

View Source

---

setEmbeds() function ➜ api.ODMessageInstance

Set the embeds of this message

View Parameters (1)

• embeds: array ➜ api.ODEmbedBuildResult[] - Parameter Description Lorem Ipsum.

View Source

---

setEphemeral() function ➜ api.ODMessageInstance

Make this message ephemeral when possible

View Parameters (1)

• ephemeral: boolean ➜ boolean - Parameter Description Lorem Ipsum.

View Source

---

setFiles() function ➜ api.ODMessageInstance

Set the files of this message

View Parameters (1)

• files: array ➜ api.ODFileBuildResult[] - Parameter Description Lorem Ipsum.

View Source

---

setPoll() function ➜ api.ODMessageInstance

Set the poll of this message

View Parameters (1)

• poll: type ➜ null|discord.PollData - Parameter Description Lorem Ipsum.

View Source

---

Defaults

under construction

We're still working on this part of the documentation!

Examples

under construction

We're still working on this part of the documentation!