Class Shortcuts

Methods for defining shortcuts.

Index

Methods

areShortcutKeysInUse createShortcut deleteShortcut getAllShortcuts isShortcutRegistered

Methods

areShortcutKeysInUse

areShortcutKeysInUse(args: { shortcutKeys: string }): boolean
Parameters
- args: { shortcutKeys: string }
  - shortcutKeys: string
    The shortcut key combination to test
Returns boolean
true if a shortcut key combination is already in use, otherwise false

createShortcut

createShortcut(args: KeyboardShortcut): void
Add a new keyboard shortcut to the group. Passing a shortcut with empty shortcutKeys does not register it. Changing the shortcut keys will not change the shortcut if already set, the previous shortcut should be removed first.
Parameters
- args: KeyboardShortcut
Returns void
Throws
InvalidStateError if the shortcut with provided shortcutId already exists

Throws
InvalidStateError if the keys combination are already in use

deleteShortcut

deleteShortcut(args: { shortcutId: string }): void
Remove the shortcut by shortcut id.
Parameters
- args: { shortcutId: string }
  - shortcutId: string
    An id of the shortcut to delete.
Returns void
Throws
InvalidStateError if the shortcut doesn't exist

Throws
InvalidStateError if the shortcut isn't a userscript shortcut

Throws
InvalidStateError if the shortcut wasn't created by the current userscript

getAllShortcuts

getAllShortcuts(): KeyboardShortcut[]
Returns KeyboardShortcut[]
all registered shortcuts of the userscript.

isShortcutRegistered

isShortcutRegistered(args: { shortcutId: string }): boolean
Parameters
- args: { shortcutId: string }
  - shortcutId: string
    An id of the shortcut to check.
Returns boolean
true if a shortcut with specified id is already registered.