Skip to main content

Class: AuralAlertSystemXmlAdapter

Defined in: src/sdk/utils/sound/AuralAlertSystemXmlAdapter.ts:299

Adapts XML-defined aural alerts to AuralAlertSystem. Handles the registration of the alerts and management of alert state.

Constructors

Constructor

new AuralAlertSystemXmlAdapter(bus, logicHost, casSystem, alertDefsRoot, parser): AuralAlertSystemXmlAdapter

Defined in: src/sdk/utils/sound/AuralAlertSystemXmlAdapter.ts:314

Creates a new instance of AuralAlertSystemXmlAdapter.

Parameters

ParameterTypeDescription
busEventBusThe event bus.
logicHostCompositeLogicXMLHostThe XML logic host used to run this adapter's XML logic.
casSystemCasSystemThe CAS system.
alertDefsRootnull | ElementThe root XML document element containing the aural alert definitions to use.
parserXmlAuralAlertParserThe parser to use to parse alert definitions from the XML document.

Returns

AuralAlertSystemXmlAdapter

Methods

start()

start(): void

Defined in: src/sdk/utils/sound/AuralAlertSystemXmlAdapter.ts:338

Registers this adapter's alerts with AuralAlertSystem and starts automatically managing alert states.

Returns

void