ODTextCommand 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 text command.

When registered, you can listen for this command using the ODCommandResponder. The advantages of using this class for creating a text command are:

• automatic option parsing (even for channels, users, roles & mentions)!
• automatic errors on invalid parameters
• error reporting to the user when the bot fails to respond
• plugins can extend this command

And more!

View Source

Properties

• builder
• id
• name

Methods

• constructor
• _change
• changed

Other

• Open Ticket Defaults
• Plugin Defaults
• Examples

Properties

---

builder interface ➜ api.ODTextCommandBuilder

The builder for this slash command.

View Source

---

inherited id class ➜ api.ODId

The id of this data.

View Source

---

name string ➜ string

The name of this slash command.

View Source

---

Methods

---

constructor() function ➜ api.ODTextCommand

(no description)

View Parameters (2)

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

View Source

---

inherited protected _change() function ➜ void

Trigger an onChange() event in the parent ODManager of this class.

View Source

---

inherited changed() function ➜ void

(❌ SYSTEM ONLY!!) Set the callback executed when a value inside this class changes.

View Parameters (1)

• callback: type ➜ null|(() => void) - 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!