Class GlobalShortcutManager`Abstract`

Register/unregister a glboal keyboard shortcut with the operating system so that you can customize the operations for various shortcuts.

Hierarchy

GlobalShortcutManager

Index

Constructors

Methods

isRegistered register unregister unregisterAll

Constructors

constructor

new GlobalShortcutManager(): GlobalShortcutManager
Returns GlobalShortcutManager

Methods

`Abstract` isRegistered

isRegistered(shortcut: string): Promise<boolean>
Checks if a given shortcut has been registered.

Returns
A Promise that resolves to a boolean whether the shortcut is already registered.
Parameters
- shortcut: string
  
  {string} [Accelerator]https://electronjs.org/docs/api/accelerator
Returns Promise<boolean>
- Defined in desktopjs/src/shortcut.ts:32

`Abstract` register

register(shortcut: string, callback: (() => void)): Promise<void>
Registers a global shortcut.
Parameters
- shortcut: string
  
  {string} [Accelerator]https://electronjs.org/docs/api/accelerator
- callback: (() => void)
  - - (): void
    - Returns void
Returns Promise<void>
- Defined in desktopjs/src/shortcut.ts:26

`Abstract` unregister

unregister(shortcut: string): Promise<void>
Removes a previously registered shortcut.
Parameters
- shortcut: string
  
  {string} [Accelerator]https://electronjs.org/docs/api/accelerator
Returns Promise<void>
- Defined in desktopjs/src/shortcut.ts:37

`Abstract` unregisterAll

unregisterAll(): Promise<void>
Removes all registered shortcuts for the current application.

Returns Promise<void>
- Defined in desktopjs/src/shortcut.ts:40