config

API Reference from the config related classes in the API

The config related classes allow you to read the open ticket configs in a controlled way. You are also able to register your own config(s) for your plugin. This way people can configure your config while it still looks a little bit like open ticket itself.

Table of contents

Name	Description
OTConfig	This class represents a config JSON file. You can create your own config or use the default open ticket configs.
OTConfigManager	This Class is a collection of all available config files registered by open ticket & plugins. It is shared with all plugins, this way they can also read the config files from other plugins.

class OTConfig:

constructor(id: String|OTId, file:String, customPath?: String) => OTConfig This method creates the OTConfig class. It tries to read the config JSON file and stores it in the data variable. It needs to be registered in an OTConfigManager class. The class normally reads the JSON files from the default ./config/ directory. When customPath is specified, it will read from the specified location

example usage:

//load the /config/test.json config file and register it to the manager
openticket.config.addConfig(new api.OTConfig("testconfig_id","test.json"))

//load the /random/idk.json config file and register it to the manager
openticket.config.addConfig(new api.OTConfig("idk_id","idk.json","random/"))

class variables:

Variable	Type	Description
data	Object	The contents of the JSON config file.
file	String	The filename of the config. For example general.json
id	OTId	The id of this config. Most of the times, this is just the name of the config.

class OTConfigManager:

Warning! This class should only be created & registered by Open Ticket itself. Plugins need this class to function properly. Replacing/extending this class could resolve in issues with other plugins

constructor() => OTConfigManager The constructor of this class has no inputs and just loads the manager. It has no other special use.

addConfig(object: OTConfig) => undefined Add an OTConfig object to the collection and make it that other plugins are able to access the config file.

example usage:

const randomconfig = new api.OTConfig("random","random.json")
openticket.config.addConfig(randomconfig)

findConfig(id: String|OTId) => OTConfig Find an OTConfig by id. The id is specified when constructing the OTConfig object.

example usage:

openticket.config.findConfig("random") //returns randomConfig from above

removeConfig(id: String|OTId) => OTConfig|false Remove a config from the collection, now it isn't accessible anymore to other plugins! If possible, the function returns the OTConfig object that got removed.

example usage:

openticket.config.removeConfig("random") //deletes randomConfig from above

class variables:

Variable	Type	Description
data	OTConfig[]	An array of registered OTConfig objects.