Class: HotkeyClient

Methods

addGlobalHotkey
(keyArr, handler, cb)

Adds a global hotkey which fires regardless of what window is in focus. If you execute this function more than once for the same key combination, both hotkeys will coexist, and would need to be removed separately.

Name Type Description
keyArr string[]

Array of strings representing a hotkey key combination.

handler Function | any

Function to be executed when the hotkey combination is pressed. It is recommended that you define a variable to represent the handler function, as the same function must be passed in order to remove the hotkey.

cb StandardCallback

Callback to be called after local hotkey is added.

Example
var myFunction = function () {...}
FSBL.Clients.HotkeyClient.addGlobalHotkey(["ctrl", "shift", "s"], myFunction, cb)

addLocalHotkey
(keyArr, handler, cb)

Adds a local hotkey which fires only when the window calling the method is in focus. If you execute this function more than once for the same key combination, both hotkeys will coexist, and would need to be removed separately.

Name Type Description
keyArr string[]

Array of strings representing hotkey key combination.

handler Function | any

Function to be executed when the hotkey combination is pressed. It is recommended that you define a variable to represent the handler function, as the same function must be passed in order to remove the hotkey.

cb StandardCallback

Callback to be called after local hotkey is added.

Example
var myFunction = function () {...}
FSBL.Clients.HotkeyClient.addLocalHotkey(["ctrl", "shift", "s"], myFunction, cb)

removeAllHotkeys
(cb)

Unregister all hotkeys, both locally and service-side.

Name Type Description
cb StandardCallback

Optional callback function

removeGlobalHotkey
(keyArr, handler, cb)

Removes a global hotkey.

Name Type Description
keyArr string[]

Array of strings representing hotkey key combination.

handler Function | any

Handler registered for the hotkey to be removed.

cb StandardCallback

Callback to be called after local hotkey is removed.

Example

FSBL.Clients.HotkeyClient.removeGlobalHotkey(["ctrl", "shift", "s"], myFunction, cb)

removeLocalHotkey
(keyArr, handler, cb)

Removes a local hotkey.

Name Type Description
keyArr string[]

Array of strings representing hotkey key combination.

handler Function | any

Handler registered for the hotkey to be removed.

cb StandardCallback

Callback to be called after local hotkey is removed.

Example

FSBL.Clients.HotkeyClient.removeLocalHotkey(["ctrl", "shift", "s"], myFunction, cb)