Skip to main content

Class: AuralAlertRegistrationManager

Defined in: src/sdk/utils/sound/AuralAlertRegistrationManager.ts:10

A manager for registering aural alerts. Alerts can be registered with an AuralAlertSystem through the manager, which also handles registration requests from the alert system.

Constructors

Constructor

new AuralAlertRegistrationManager(bus): AuralAlertRegistrationManager

Defined in: src/sdk/utils/sound/AuralAlertRegistrationManager.ts:20

Creates a new instance of AuralAlertRegistrationManager.

Parameters

ParameterTypeDescription
busEventBusThe event bus.

Returns

AuralAlertRegistrationManager

Methods

destroy()

destroy(): void

Defined in: src/sdk/utils/sound/AuralAlertRegistrationManager.ts:56

Destroys this manager.

Returns

void


register()

register(definition): void

Defined in: src/sdk/utils/sound/AuralAlertRegistrationManager.ts:31

Registers an aural alert.

Parameters

ParameterTypeDescription
definitionReadonly<AuralAlertDefinition>The definition of the alert to register.

Returns

void