Class GlobalHotkey

The GlobalHotkey module can register/unregister a global hotkeys.

Namespace

Hierarchy

EmitterBase<OpenFin.GlobalHotkeyEvent>
- GlobalHotkey

Index

Constructors

constructor

Properties

addListener wire

Accessors

Methods

emit eventNames isRegistered listenerCount listeners on once prependListener prependOnceListener register removeAllListeners removeListener unregister unregisterAll

Constructors

constructor

new GlobalHotkey(wire: Transport<EntityType>): GlobalHotkey
Parameters
- wire: Transport<EntityType>
Returns GlobalHotkey

Overrides EmitterBase<OpenFin.GlobalHotkeyEvent>.constructor

Properties

addListener

addListener: (<EventType>(eventType: EventType, listener: EventHandler<OpenFin.GlobalHotkeyEvents.GlobalHotkeyEvent, EventType>, options?: SubscriptionOptions) => Promise<GlobalHotkey>) = ...

Type declaration

- <EventType>(eventType: EventType, listener: EventHandler<OpenFin.GlobalHotkeyEvents.GlobalHotkeyEvent, EventType>, options?: SubscriptionOptions): Promise<GlobalHotkey>
- Type Parameters
  - EventType extends "registered" | "unregistered"
  Parameters
  - eventType: EventType
  - listener: EventHandler<OpenFin.GlobalHotkeyEvents.GlobalHotkeyEvent, EventType>
  - Optional options: SubscriptionOptions
  Returns Promise<GlobalHotkey>

wire

wire: Transport<EntityType>

Accessors

me

get me(): Identity
Returns Identity

Inherited from EmitterBase.me

Methods

emit

emit<EventType>(eventType: EventType, payload: Extract<EmitterEvent, {
type: EventType;
}>, ...args: any[]): boolean
Type Parameters
- EventType extends string
Parameters
- eventType: EventType
- payload: Extract<EmitterEvent, {
  type: EventType;
  }>
- Rest ...args: any[]
Returns boolean

Inherited from EmitterBase.emit

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]

Inherited from EmitterBase.eventNames

isRegistered

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

Returns

Tutorial
GlobalHotkey.isRegistered
Parameters
- hotkey: string
  
  a hotkey string
Returns Promise<boolean>

listenerCount

listenerCount(type: string | symbol): number
Parameters
- type: string | symbol
Returns number

Inherited from EmitterBase.listenerCount

listeners

listeners(type: string | symbol): Function[]
Parameters
- type: string | symbol
Returns Function[]

Inherited from EmitterBase.listeners

on

on<EventType>(eventType: EventType, listener: EventHandler<OpenFin.GlobalHotkeyEvents.GlobalHotkeyEvent, EventType>, options?: SubscriptionOptions): Promise<GlobalHotkey>
Type Parameters
- EventType extends "registered" | "unregistered"
Parameters
- eventType: EventType
- listener: EventHandler<OpenFin.GlobalHotkeyEvents.GlobalHotkeyEvent, EventType>
- Optional options: SubscriptionOptions
Returns Promise<GlobalHotkey>

Inherited from EmitterBase.on

once

once<EventType>(eventType: EventType, listener: EventHandler<OpenFin.GlobalHotkeyEvents.GlobalHotkeyEvent, EventType>, options?: SubscriptionOptions): Promise<GlobalHotkey>
Type Parameters
- EventType extends "registered" | "unregistered"
Parameters
- eventType: EventType
- listener: EventHandler<OpenFin.GlobalHotkeyEvents.GlobalHotkeyEvent, EventType>
- Optional options: SubscriptionOptions
Returns Promise<GlobalHotkey>

Inherited from EmitterBase.once

prependListener

prependListener<EventType>(eventType: EventType, listener: EventHandler<OpenFin.GlobalHotkeyEvents.GlobalHotkeyEvent, EventType>, options?: SubscriptionOptions): Promise<GlobalHotkey>
Type Parameters
- EventType extends "registered" | "unregistered"
Parameters
- eventType: EventType
- listener: EventHandler<OpenFin.GlobalHotkeyEvents.GlobalHotkeyEvent, EventType>
- Optional options: SubscriptionOptions
Returns Promise<GlobalHotkey>

Inherited from EmitterBase.prependListener

prependOnceListener

prependOnceListener<EventType>(eventType: EventType, listener: EventHandler<OpenFin.GlobalHotkeyEvents.GlobalHotkeyEvent, EventType>, options?: SubscriptionOptions): Promise<GlobalHotkey>
Type Parameters
- EventType extends "registered" | "unregistered"
Parameters
- eventType: EventType
- listener: EventHandler<OpenFin.GlobalHotkeyEvents.GlobalHotkeyEvent, EventType>
- Optional options: SubscriptionOptions
Returns Promise<GlobalHotkey>

Inherited from EmitterBase.prependOnceListener

register

register(hotkey: string, listener: ((...args: any[]) => void)): Promise<void>
Registers a global hotkey with the operating system.

Returns

Tutorial
GlobalHotkey.register
Parameters
- hotkey: string
  
  a hotkey string
- listener: ((...args: any[]) => void)
  
  called when the registered hotkey is pressed by the user.
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns Promise<void>

removeAllListeners

removeAllListeners(eventType?: "registered" | "unregistered"): Promise<GlobalHotkey>
Parameters
- Optional eventType: "registered" | "unregistered"
Returns Promise<GlobalHotkey>

Inherited from EmitterBase.removeAllListeners

removeListener

removeListener<EventType>(eventType: EventType, listener: EventHandler<OpenFin.GlobalHotkeyEvents.GlobalHotkeyEvent, EventType>, options?: SubscriptionOptions): Promise<GlobalHotkey>
Type Parameters
- EventType extends "registered" | "unregistered"
Parameters
- eventType: EventType
- listener: EventHandler<OpenFin.GlobalHotkeyEvents.GlobalHotkeyEvent, EventType>
- Optional options: SubscriptionOptions
Returns Promise<GlobalHotkey>

Inherited from EmitterBase.removeListener

unregister

unregister(hotkey: string): Promise<void>
Unregisters a global hotkey with the operating system.

Returns

Tutorial
GlobalHotkey.unregister
Parameters
- hotkey: string
  
  a hotkey string
Returns Promise<void>

unregisterAll

unregisterAll(): Promise<void>
Unregisters all global hotkeys for the current application.

Returns

Tutorial
GlobalHotkey.unregisterAll

Returns Promise<void>

Class GlobalHotkey

Namespace

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

wire: Transport<EntityType>

Returns GlobalHotkey

Properties

addListener

Type declaration

Type Parameters

EventType extends "registered" | "unregistered"

Parameters

eventType: EventType

listener: EventHandler<OpenFin.GlobalHotkeyEvents.GlobalHotkeyEvent, EventType>

Optional options: SubscriptionOptions

Returns Promise<GlobalHotkey>

wire

Accessors

me

Returns Identity

Methods

emit

Type Parameters

EventType extends string

Parameters

eventType: EventType

payload: Extract<EmitterEvent, { type: EventType; }>

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

isRegistered

Returns

Tutorial

Parameters

hotkey: string

Returns Promise<boolean>

listenerCount

Parameters

type: string | symbol

Returns number

listeners

Parameters

type: string | symbol

Returns Function[]

on

Type Parameters

EventType extends "registered" | "unregistered"

Parameters

eventType: EventType

listener: EventHandler<OpenFin.GlobalHotkeyEvents.GlobalHotkeyEvent, EventType>

Optional options: SubscriptionOptions

Returns Promise<GlobalHotkey>

once

Type Parameters

EventType extends "registered" | "unregistered"

Parameters

eventType: EventType

listener: EventHandler<OpenFin.GlobalHotkeyEvents.GlobalHotkeyEvent, EventType>

Optional options: SubscriptionOptions

Returns Promise<GlobalHotkey>

prependListener

Type Parameters

EventType extends "registered" | "unregistered"

Parameters

eventType: EventType

listener: EventHandler<OpenFin.GlobalHotkeyEvents.GlobalHotkeyEvent, EventType>

Optional options: SubscriptionOptions

Returns Promise<GlobalHotkey>

prependOnceListener

Type Parameters

EventType extends "registered" | "unregistered"

Parameters

`Optional` options: SubscriptionOptions

payload: Extract<EmitterEvent, {
type: EventType;
}>

`Rest` ...args: any[]

`Optional` options: SubscriptionOptions

`Optional` options: SubscriptionOptions

`Optional` options: SubscriptionOptions

`Optional` options: SubscriptionOptions

`Rest` ...args: any[]

`Optional` eventType: "registered" | "unregistered"

`Optional` options: SubscriptionOptions