OTRS API Reference JavaScript

Namespace: Core.Config

Core. Config

This namespace contains the config options and functions.
Author:
  • OTRS AG
Source:

Methods

(static) AddConfig(Data, ConfigKey)

This function includes the given data into the config hash.
Parameters:
Name Type Description
Data Object The config data to include as a javascript object
ConfigKey String The key in the config where the data structure is saved to. If undefined, the Data is added to the root of the hash.
Source:

(static) Get(Key, DefaultValueopt) → {Object}

Gets a single config value.
Parameters:
Name Type Attributes Description
Key String The name of the config option (also combined ones like Richtext.Width).
DefaultValue Object <optional>
 If nothing is saved in the config, return this default value.
Source:
Returns:
The value of the option. Can be every kind of javascript variable type. Returns undefined if setting could not be found.
Type
Object

(static) Set(Key, Value)

Sets a single config value.
Parameters:
Name Type Description
Key String The name of the config option (also combined ones like Richtext.Width)
Value Object The value of the option. Can be every kind of javascript variable type.
Source: