Class DeviceEvent

Class representing a device event.

Implements

IDeviceEvent

Index

Constructors

Properties

Methods

dispatch subscribe subscribeAsync

Constructors

constructor

new DeviceEvent(): DeviceEvent
Creates a new instance of a Device event.

Returns DeviceEvent

Properties

`Private` `Readonly` _Target

_Target: SubEvent<DeviceEventArgs> = ...

Methods

dispatch

dispatch(sender, serialNumber): boolean
Dispatches the event to all subscribed handlers.
Parameters
- sender: IDeviceManager
  The sender of the event.
- serialNumber: string
  The serial number of the device.
Returns boolean
- Returns true after the event has been dispatched.

subscribe

subscribe(handler): IEventSubscription
Subscribes a handler to the event.
Parameters
- handler: DeviceEventHandler
  The handler function to subscribe to the event.
Returns IEventSubscription
- The subscription object, which can be used to cancel the subscription.
Implementation of IDeviceEvent.subscribe

subscribeAsync

subscribeAsync(handler): IEventSubscription
Subscribes an asynchronous handler to the event.
Parameters
- handler: DeviceEventAsyncHandler
  The asynchronous handler function to subscribe to the event.
Returns IEventSubscription
- The subscription object, which can be used to cancel the subscription.
Implementation of IDeviceEvent.subscribeAsync