Class GlobalHotkey

Deprecated

me should only be accessed from the fin global (FinApi.me); access through entity classes is not guaranteed to behave sensibly in all calling contexts.

Adds a listener to the end of the listeners array for the specified event.

Checks if a given hotkey has been registered by an application within the current runtime.

Example

const hotkey = 'CommandOrControl+X';

fin.GlobalHotkey.isRegistered(hotkey)
.then((registered) => {
    console.log(`hotkey ${hotkey} is registered ? ${registered}`);
})
.catch(err => {
    console.log('Error unregistering the hotkey', err);
});
Copy

Adds a listener to the end of the listeners array for the specified event.

Remarks

Event payloads are documented in the OpenFin.Events namespace.

Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.

Remarks

Event payloads are documented in the OpenFin.Events namespace.

Adds a listener to the beginning of the listeners array for the specified event.

Remarks

Event payloads are documented in the OpenFin.Events namespace.

Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed. The listener is added to the beginning of the listeners array.

Remarks

Event payloads are documented in the OpenFin.Events namespace.

Registers a global hotkey with the operating system.

Throws

If the hotkey is reserved, see list below.

Throws

if the hotkey is already registered by another application.

Remarks

The hotkey parameter expects an electron compatible accelerator and the listener will be called if the hotkey is pressed by the user. If successfull, the hotkey will be 'claimed' by the application, meaning that this register call can be called multiple times from within the same application but will fail if another application has registered the hotkey.
The register call will fail if given any of these reserved Hotkeys:

• CommandOrControl+0
• CommandOrControl+=
• CommandOrControl+Plus
• CommandOrControl+-
• CommandOrControl+_
• CommandOrControl+Shift+I
• F5
• CommandOrControl+R
• Shift+F5
• CommandOrControl+Shift+R

Raises the registered event.

Example

const hotkey = 'CommandOrControl+X';

fin.GlobalHotkey.register(hotkey, () => {
console.log(`${hotkey} pressed`);
})
.then(() => {
    console.log('Success');
})
.catch(err => {
    console.log('Error registering the hotkey', err);
});
Copy

Removes all listeners, or those of the specified event.

Remove a listener from the listener array for the specified event.

Remarks

Caution: Calling this method changes the array indices in the listener array behind the listener.

Unregisters a global hotkey with the operating system.

Remarks

This method will unregister all existing registrations of the hotkey within the application. Raises the unregistered event.

Example

const hotkey = 'CommandOrControl+X';

fin.GlobalHotkey.unregister(hotkey)
.then(() => {
    console.log('Success');
})
.catch(err => {
    console.log('Error unregistering the hotkey', err);
});
Copy

Unregisters all global hotkeys for the current application.

Remarks

Raises the unregistered event for each hotkey unregistered.

Example

fin.GlobalHotkey.unregisterAll()
.then(() => {
    console.log('Success');
})
.catch(err => {
    console.log('Error unregistering all hotkeys for this application', err);
});
Copy