Skip to main content

ODCommandResponder 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 command responder.

This class manages all workers which are executed when the related command is triggered.

View Source

Properties​

Methods​

Other​

Properties​

inherited id class ➜ api.ODId​

The id of this data.

View Source

inherited match type ➜ string|RegExp​

The commandName or customId needs to match this string or regex for this responder to be executed.

View Source

prefix string ➜ string​

The prefix of the text command needs to match this

View Source

inherited workers class ➜ api.ODWorkerManager​

The manager that has all workers of this implementation

View Source

Methods​

constructor() function ➜ api.ODCommandResponder​

(no description)

View Parameters (6)
  • id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.
  • prefix: string ➜ string - Parameter Description Lorem Ipsum.
  • match: type ➜ string|RegExp - Parameter Description Lorem Ipsum.
  • callback: type ➜ api.ODWorkerCallback - Parameter Description Lorem Ipsum.
  • priority: number ➜ number - Parameter Description Lorem Ipsum.
  • callbackId: type ➜ api.ODValidId - 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

respond() function ➜ Promise​

Respond to this command

View Parameters (3)
  • instance: class ➜ api.ODCommandResponderInstance - Parameter Description Lorem Ipsum.
  • source: type ➜ Source - Parameter Description Lorem Ipsum.
  • params: type ➜ Params - 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!