ODHelpMenuCommandComponent 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 help menu command component.

It contains a useful helper to render a command in the Open Ticket help menu.

View Source

Properties

• id
• priority
• render

Methods

• constructor
• _change
• changed

Other

• Open Ticket Defaults
• Plugin Defaults
• Examples

Properties

---

inherited id class ➜ api.ODId

The id of this data.

View Source

---

inherited priority number ➜ number

The priority of this component. The higher, the earlier it will appear in the help menu.

View Source

---

inherited render type ➜ api.ODHelpMenuComponentRenderer

The render function for this component.

View Source

---

Methods

---

constructor() function ➜ api.ODHelpMenuCommandComponent

(no description)

View Parameters (3)

• id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.
• priority: number ➜ number - Parameter Description Lorem Ipsum.
• settings: interface ➜ api.ODHelpMenuCommandComponentSettings - 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!