Skip to main content

ODOption 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 option.

This class contains all data related to this option (parsed from the config).

It's recommended to use ODTicketOption, ODWebsiteOption or ODRoleOption instead!

View Source

Properties​

Methods​

Other​

Properties​

id class ➜ api.ODId​

The id of this option. (from the config)

View Source

inherited redirects class ➜ api.ODManagerRedirectHelper​

Handle all redirects in this ODManager

View Source

type string ➜ string​

The type of this option. (e.g. opendiscord:ticket, opendiscord:website, opendiscord:role)

View Source

Methods​

constructor() function ➜ api.ODOption​

(no description)

View Parameters (3)
  • id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.
  • type: string ➜ string - Parameter Description Lorem Ipsum.
  • data: array ➜ api.ODOptionData[] - 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 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)

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.ODOptionData​

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.ODOptionData[]​

Get all data inside this manager

View Source

inherited getFiltered() function ➜ api.ODOptionData[]​

Get all data that matches inside the filter function

View Parameters (1)

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.ODOptionData[]​

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)

View Source

inherited onAdd() function ➜ void​

Listen for when data is added to this manager.

View Parameters (1)

View Source

inherited onChange() function ➜ void​

Listen for when data is changed in this manager.

View Parameters (1)

View Source

inherited onRemove() function ➜ void​

Listen for when data is removed from this manager.

View Parameters (1)

View Source

inherited remove() function ➜ null|api.ODOptionData​

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

View Parameters (1)
  • id: type ➜ api.ODValidId - Parameter Description Lorem Ipsum.

View Source

toJson() function ➜ api.ODOptionJson​

Convert this option to a JSON object for storing this option in the database.

View Parameters (1)
  • version: class ➜ api.ODVersion - Parameter Description Lorem Ipsum.

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

static fromJson() function ➜ api.ODOption​

Create an option from a JSON object in the database.

View Parameters (1)

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!