Class: CasAuralAlertTransporter

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

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:112

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

Returns

void

---

create()

static create(bus, auralUuid, auralActivation, casUuid, casPriority, casSuffix, includeAcknowledged, casSystem?): CasAuralAlertTransporter

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

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.
auralUuid	string	The ID of the transporter's aural alert.
auralActivation	undefined | () => undefined | AuralAlertActivation	A function which generates activation data for the transporter's aural alert. If the function returns undefined or is itself not defined, the aural alert will be activated using its default registered parameters.
casUuid	string	The ID of the CAS alert to which to bind the transporter's aural alert.
casPriority	AnnunciationType	The priority level of the CAS alert to which to bind the transporter's aural alert.
casSuffix	undefined | string	The suffix, if any, of the CAS alert to which to bind the transporter's aural alert.
includeAcknowledged	boolean	Whether to activate the transporter's aural alert when the bound CAS alert is acknowledged.
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.