CustomEvent - Client

You can use CustomEvent API to show qualified embedded help in the right sidebar.

See Use embedded help qualifiers for more information.

CustomEvent - fireAll(String event, String qualifier)

Show the embedded-help content specified by the qualifier parameter in the right sidebar.

Before using the fireAll() method, you must have created the Embedded Help qualifier and help content.

Table 1. Parameters
Name Type Description
event String The event to send. Must be the string "embedded_help:load_embedded_help"
qualifier String The qualifier name created in the Embedded Help application.
Table 2. Returns
Type Description
var qualifier = 'your-EH-qualifier';
		CustomEvent.fireAll("embedded_help:load_embedded_help", qualifier);