OTRS API Reference JavaScript

Namespace: Core.App

Core. App

This namespace contains main app functionalities.
Author:
  • OTRS AG
Source:

Namespaces

Responsive

Methods

(static) BindWindowUnloadEvent(Namespace, CallbackFunction)

Binds a crossbrowser compatible unload event to the window object
Parameters:
Name Type Description
Namespace String Namespace for which the event should be bound.
CallbackFunction function Function which should be executed once the event is fired.
Source:

(static) BrowserCheck(Interface) → {Boolean}

Checks if the used browser is not on the OTRS browser blacklist of the agent interface.
Parameters:
Name Type Description
Interface String The interface we are in (Agent or Customer)
Source:
Returns:
True if the used browser is *not* on the black list.
Type
Boolean

(static) BrowserCheckIECompatibilityMode() → {Boolean}

Checks if the used browser is IE in Compatibility Mode. IE11 in Compatibility Mode is not recognized.
Source:
Returns:
True if the used browser is IE in Compatibility Mode.
Type
Boolean

(static) EscapeHTML(StringToEscape) → {String}

Escapes the special HTML characters ( < > & ") in supplied string to their corresponding entities.
Parameters:
Name Type Description
StringToEscape String The string which is supposed to be escaped.
Source:
Returns:
The escaped string.
Type
String

(static) EscapeSelector(Selector) → {String}

Escapes the special characters (. :) in the given jQuery Selector jQ does not allow the usage of dot or colon in ID or class names An overview of special characters that should be quoted can be found here: https://api.jquery.com/category/selectors/
Parameters:
Name Type Description
Selector String The original selector (e.g. ID, class, etc.).
Source:
Returns:
The escaped selector.
Type
String

(static) GetSessionInformation() → {Object}

Collects session data in a hash if available.
Source:
Returns:
Hash with session data, if needed.
Type
Object

(static) HumanReadableDataSize(Size) → {String}

Formats bytes as human readable text (like 45.6 MB).
Parameters:
Name Type Description
Size Number Bytes which needs to be formatted
Source:
Returns:
Result string.
Type
String

(static) Init()

This function initializes the special functions.
Source:

(static) InternalRedirect(Data)

Performs an internal redirect based on the given data parameters. If needed, session information like SessionID and ChallengeToken are appended.
Parameters:
Name Type Description
Data Object The query data (like: {Action: 'MyAction', Subaction: 'Add'})
Source:

(static) Publish(Topic, Args)

Publish some data on a named topic.
Parameters:
Name Type Description
Topic String The channel to publish on
Args Array The data to publish. Each array item is converted into an ordered arguments on the subscribed functions.
Source:

(static) Ready(Callback)

This functions callback is executed if all elements and files of this page are loaded.
Parameters:
Name Type Description
Callback function The callback function to be executed.
Source:

(static) ReturnToPreviousPage()

This function bind on click event to return on previous page.
Source:

(static) Subscribe(Topic, Callback) → {Array}

Register a callback on a named topic.
Parameters:
Name Type Description
Topic String The channel to subscribe to
Callback function The handler event. Anytime something is published on a subscribed channel, the callback will be called with the published array as ordered arguments.
Source:
Returns:
A handle which can be used to unsubscribe this particular subscription
Type
Array

(static) UnbindWindowUnloadEvent(Namespace)

Unbinds a crossbrowser compatible unload event to the window object
Parameters:
Name Type Description
Namespace String Namespace for which the event should be removed.
Source:

(static) Unsubscribe(Handle)

Disconnect a subscribed function for a topic.
Parameters:
Name Type Description
Handle Array The return value from a $.subscribe call
Source: