The callback function to be called when the hotkey is pressed, or null to remove it
The callback function to be called when the hotkey is released, or null to remove it
The callback function to be called repeatedly while the hotkey is held down, or null to remove it. Repeats at the system keyboard-repeat delay/interval, matching how held-down keys repeat elsewhere in macOS.
ReadonlykeyThe key this hotkey was bound with, as originally passed to bind()/create()
An optional description of what this hotkey does, or null if none was set.
When set, it is shown as an on-screen toast via hs.ui.alert() (duration controlled by
hs.hotkey.alertDuration) just before the hotkey's callback runs: before the pressed
callback if one exists, otherwise before the released callback if one exists.
ReadonlymodsThe modifier keys this hotkey was bound with, as originally passed to bind()/create()
Disable and permanently remove this hotkey, releasing all associated resources
Disable the hotkey
Enable the hotkey
True if the hotkey was enabled, otherwise False
Check if the hotkey is currently enabled
True if the hotkey is enabled, otherwise False
Object representing a system-wide hotkey. You should not create these objects directly, but rather, use the methods in hs.hotkey to instantiate these.