OTRS API Reference JavaScript

Members

(static) SearchButtonClicked :Object

Needed for the handling of searches with ActiveAutoComplete = 0.

Type:

• Object

Methods

(static) GetConfig(Key) → {Object}

gets the config value of a specific key.

Parameters:

Name	Type	Description
Key	String	The config option name.

Returns:

Config option value.

Type

Object

(static) Init($Element, SourceFunction, SelectFunction, Type, Options)

This function initializes autocomplete on an input element.

Parameters:

Name	Type	Description
$Element	jQueryObject	The element which gets autocomplete infos.
SourceFunction	Core.UI.Autocomplete~SourceFunction	Defines the source data for the autocomplete.
SelectFunction	Core.UI.Autocomplete~SelectFunction	Is executed, if an entry is selected.
Type	String	of autocompletion, e.g. "CustomerSearch" etc.
Options	Object	object data with autocomplete plugin options

Type Definitions

SelectFunction(Event, UI)

Parameters:

Name	Type	Description
Event	EventObject	The original browser event object.
UI	Object	The data given from the UI (e.g. UI.item is the selected autocomplete list item).

SourceFunction(Request, Response) → {Array}

Parameters:

Name	Type	Description
Request	String	The data provided by the autocomplete (e.g. the entered text).
Response	function	The function defined by the autocomplete to call with the selected data.

Returns:

Data collected for autocompletion, every array element is an object with label and value keys.

Type

Array