Class: CasAuralAlertTransporter

Defined in: src/sdk/utils/sound/CasAuralAlertTransporter.ts:42

Binds the state of an aural alert to the displayed state of a CAS alert and transports the aural alert state to AuralAlertSystem.

Methods

destroy()

destroy(): void

Defined in: src/sdk/utils/sound/CasAuralAlertTransporter.ts:157

Destroys this transporter. Once destroyed, it will no longer automatically manage the state of its aural alert.

Returns

void

---

create()

static create(bus, options, casSystem?): CasAuralAlertTransporter

Defined in: src/sdk/utils/sound/CasAuralAlertTransporter.ts:170

Creates a new instance of CasAuralAlertTransporter, which will automatically activate and deactivate an aural alert based on whether a bound CAS alert is being displayed as a message.

Parameters

Parameter	Type	Description
bus	EventBus	The event bus.
options	Readonly<CasAuralAlertTransporterOptions>	Options with which to configure the transporter.
casSystem?	CasSystem	The CAS system. If not defined, the transporter should be created before its bound CAS alert can be activated. Otherwise the initialization of the aural alert's state cannot be guaranteed to be correct.

Returns

CasAuralAlertTransporter

A new instance of CasAuralAlertTransporter.