ODTextCommandManager 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 client text manager.

It's responsible for managing all the text commands from the client.

Here, you can add & remove text commands & the bot will do the (de)registering.

View Source

Properties

• listenerLimit
• manager
• redirects

Methods

• constructor
• _change
• add
• changed
• exists
• get
• getAll
• getFiltered
• getIds
• getLength
• getRegex
• loopAll
• onAdd
• onChange
• onError
• onInteraction
• onRemove
• remove
• startListeningToInteractions
• useDebug

Other

• Open Ticket Defaults
• Plugin Defaults
• Examples

Properties

---

listenerLimit number ➜ number

Set the soft limit for maximum amount of listeners. A warning will be shown when there are more listeners than this limit.

View Source

---

manager class ➜ api.ODClientManager

Copy of discord.js client.

View Source

---

inherited redirects class ➜ api.ODManagerRedirectHelper

Handle all redirects in this ODManager

View Source

---

Methods

---

constructor() function ➜ api.ODTextCommandManager

(no description)

View Parameters (2)

• debug: class ➜ api.ODDebugger - Parameter Description Lorem Ipsum.
• manager: class ➜ api.ODClientManager - Parameter Description Lorem Ipsum.

View Source

---

inherited protected _change() function ➜ void

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

View Source

---

add() function ➜ boolean

Add data to the manager. The id will be fetched from the data class! You can optionally select to overwrite existing data!

View Parameters (2)

• data: class ➜ api.ODTextCommand - Parameter Description Lorem Ipsum.
• overwrite: boolean ➜ boolean - Parameter Description Lorem Ipsum.

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

---

inherited exists() function ➜ boolean

Check if data that matches the ODId exists. Returns a boolean.

View Parameters (1)

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

View Source

---

inherited get() function ➜ null|api.ODTextCommand

Get data that matches the ODId. Returns the found data.

View Parameters (1)

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

View Source

---

inherited getAll() function ➜ api.ODTextCommand[]

Get all data inside this manager

View Source

---

inherited getFiltered() function ➜ api.ODTextCommand[]

Get all data that matches inside the filter function

View Parameters (1)

• predicate: function ➜ (value:api.ODTextCommand, index:number, array:api.ODTextCommand[]) => unknown - Parameter Description Lorem Ipsum.

View Source

---

inherited getIds() function ➜ api.ODId[]

Get a list of all the ids inside this manager

View Source

---

inherited getLength() function ➜ number

Get the length of the data inside this manager

View Source

---

inherited getRegex() function ➜ api.ODTextCommand[]

Get all data that matches the regex

View Parameters (1)

• regex: type ➜ RegExp - Parameter Description Lorem Ipsum.

View Source

---

inherited loopAll() function ➜ Promise

Run an iterator over all data in this manager. This method also supports async-await behaviour!

View Parameters (1)

• cb: function ➜ (data:api.ODTextCommand, id:api.ODId) => api.ODPromiseVoid - Parameter Description Lorem Ipsum.

View Source

---

inherited onAdd() function ➜ void

Listen for when data is added to this manager.

View Parameters (1)

• callback: type ➜ api.ODManagerAddCallback - Parameter Description Lorem Ipsum.

View Source

---

inherited onChange() function ➜ void

Listen for when data is changed in this manager.

View Parameters (1)

• callback: type ➜ api.ODManagerCallback - Parameter Description Lorem Ipsum.

View Source

---

onError() function ➜ void

Callback on error from all the registered text commands

View Parameters (1)

• callback: type ➜ api.ODTextCommandErrorCallback - Parameter Description Lorem Ipsum.

View Source

---

onInteraction() function ➜ void

Callback on interaction from one of the registered text commands

View Parameters (3)

• commandPrefix: string ➜ string - Parameter Description Lorem Ipsum.
• commandName: type ➜ string|RegExp - Parameter Description Lorem Ipsum.
• callback: type ➜ api.ODTextCommandInteractionCallback - Parameter Description Lorem Ipsum.

View Source

---

inherited onRemove() function ➜ void

Listen for when data is removed from this manager.

View Parameters (1)

• callback: type ➜ api.ODManagerCallback - Parameter Description Lorem Ipsum.

View Source

---

inherited remove() function ➜ null|api.ODTextCommand

Remove data that matches the ODId. Returns the removed data.

View Parameters (1)

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

View Source

---

startListeningToInteractions() function ➜ void

Start listening to the discord.js client messageCreate event.

View Source

---

inherited useDebug() function ➜ void

Use the Open Ticket debugger in this manager for logs

View Parameters (2)

• debug: class ➜ api.ODDebugger - Parameter Description Lorem Ipsum.
• debugname: string ➜ string - 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!