ShortcutKey Service

Allows gadgets or components to create shortcut keys for any component or gadget-related actions.

Example

Copyfinesse.shortcutkey.ShortcutKeyService.registerShortcutKey(arr);

Methods

getShorcutKeys()

Retrieves all the registered shortcut keys.

Example

Copyfinesse.shortcutkey.ShortcutKeyService.getShortcutKeys();

Returns

{Array} The array of objects. The objects content includes the following:

• {String} accessKey—The key combination for the shortcut.

• {String} actionName—The name of the action or operation performed by the assigned shortcut keys.

• {String} componentName—The name of the functionality, component, or the gadget.

• {Boolean} conflict—Determines whether the shortcut key is conflicting with another shortcut key.

• {Enum} executionScope—Determines the execution scope.

• {Function} handler—The function that is invoked when the shortcut keys are pressed.

• {String} id—Unique identifier of the gadget.

• {Boolean} isPageLevel—Determines whether the shortcut key is at the page level.

• {String} key—The main key to be combined with modifier keys.

• {String} modifierKeys—The modifier key is used commonly in keyboard shortcuts on the host platform.

• {String} type—Determines whether the shortcut key runs on component or gadget.

init()

Initiates the ShortcutKeyService for the Container or the gadgets.

Example

Copyfinesse.shortcutkey.ShortcutKeyService.init();

registerShortcutKey(keys)

Registers the shortcut keys for the components or the gadgets. A key combination consists of a main key and a set of modifier keys. The main key is specified by its key character - key. A modifier key is Shift, Ctrl, Alt, or the combination.

Parameters

Example

Copyfinesse.shortcutkey.ShortcutKeyService.init();
finesse.shortcutkey.ShortcutKeyService.registerShortcutKey(
    [{
        "id": "cisco_sample_gadget",
        "componentName": "Sample gadget",
        "actionName": "Sample gadget action name",
        "modifierKeys": finesse.shortcutkey.ShortcutKeyService.CONSTANTS.MODIFIER_KEYS_CTRL,
        "key": "e",
        "executionScope": "activeTab",
        "handler": function() {}
    }]);

The following table lists the shortcut key registration payload details.

ShortcutKeyService.CONSTANTS

The following table lists the predefined modifier keys.

sendKeyupEvent(keyEvent)

Sends the Keyup event object to the Finesse container. If there is any custom iFrame created by the gadget that is not controlled by Finesse, then the Finesse shortcut key framework cannot capture the KeyupEvent from that custom iFrame to run the shortcut keys.

The Keyup event occurs when a keyboard key is released. The Keyup event object is captured inside the child iFrame and propagated to its immediate parent. The parent again has to propagate the event until the event reaches the Finesse container. When the immediate parent is the Finesse container, then use sendKeyupEvent to propagate the event to Finesse container. Param object has to be serializable and cannot contain any functions.

Example

Copyvar keyEvent = {
    ctrlKey: event.ctrlKey,
    altKey: event.altKey,
    shiftKey: event.shiftKey,
    keyCode: event.keyCode,
    key: event.key
};
 
sendKeyupEvent(keyEvent);

Parameters

Shortcut Keys List

The following table lists out-of-the-box agent-specific shortcut keys which should not be used by third-party applications. If the same shortcut keys are used it results in conflict.