McDewey

Multi-vendor documentation library · semantic search · MCP endpoint at /mcp

Page 537

↗ View in doc context
page
537
source
finesse/v12.5/developer-guide/developer-guide.md
chunk_id
finesse::v12.5::developer-guide::developer-guide::521

Required Description Type Name Yes Determines the execution scope. • activeTab: If the gadget is in currently active tab, only then the shortcut keys of that gadget are run. • activeFrame: If the gadget is in focus, only then the shortcut keys of that gadget are run. For more information on CONSTANTS, see ShortcutKeyService.CONSTANTS, on page 521. Enum executionScope Yes The function that is invoked when the shortcut keys are pressed. Function handler ShortcutKeyService.CONSTANTS The following table lists the predefined modifier keys. Modifier Key Shortcut Key finesse.shortcutkey.ShortcutKeyService.CONSTANTS.MODIFIER_KEYS.CTRL_SHIFT Ctrl + Shift finesse.shortcutkey.ShortcutKeyService.CONSTANTS.MODIFIER_KEYS.ALT_SHIFT Alt + Shift finesse.shortcutkey.ShortcutKeyService.CONSTANTS.MODIFIER_KEYS.CTRL_ALT Ctrl + Alt finesse.shortcutkey.ShortcutKeyService.CONSTANTS.MODIFIER_KEYS.CTRL Ctrl finesse.shortcutkey.ShortcutKeyService.CONSTANTS.MODIFIER_KEYS.SHIFT Shift finesse.shortcutkey.ShortcutKeyService.CONSTANTS.MODIFIER_KEYS.ALT Alt • When shortcut keys are used, the callback that is registered by the gadget is run. The gadgets or components perform a specific action on callback. • Components or gadgets register the shortcut keys on a successful sign in to Finesse desktop. • After deploying the third-party gadgets, sign in as an agent and as a supervisor to check if there are any shortcut key conflicts. Resolve them if any. Note 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. Cisco Finesse Web Services Developer and JavaScript Guide, Release 12.5(1) 521 Cisco Finesse JavaScript APIs ShortcutKey Service