AlertApi

Provides run-time access to Alert function and associated State

TypeScript

export interface

Methods

Method	Returns	Description
addAlertDefinition(alertDefinition)	`AlertDefinition`	Adds given Alert Definition to Adaptable State
applyScheduledAlertDefinition(alertDefinition)	`void`	Fires a scheduled alert definition (notification, system status, etc.)
deleteAlertDefinition(alertDefinition)	`void`	Deletes given Alert Definition from Adaptable State
displayAdaptableAlert(alertToShow)	`Promise<void>`	Displays the given Adaptable Alert
displayAdaptableAlertNotification(alert)	`void`	Displays given Alert as a Toast
editAlertDefinition(alertDefinition)	`AlertDefinition`	Updates given Alert Definition in Adaptable State
evaluateAlertDefinitions(alertDefinitions)	`void`	Evaluates the given Alert Definitions - will fire Alert if rule is met
findAlertDefinitions(alertLookupCriteria)	`AlertDefinition[]`	Find all Alert Definitions which match the given criteria
getActiveAlertDefinitions(config)	`AlertDefinition[]`	Retrieves all Alert Definitions which are currently active
getAlertDefinitionById(id, config)	`AlertDefinition`	Retrieves alert definition by the technical ID (from `AlertState`)
getAlertDefinitionByName(name)	`AlertDefinition` `\| undefined`	Retrieves an Alert Definition by its Name
getAlertDefinitions(config)	`AlertDefinition[]`	Retrieves all Alert Definitions in Alert State
getAlertState()	`AlertState`	Retrieves Alert section from Adaptable State
getSuspendedAlertDefinitions(config)	`AlertDefinition[]`	Retrieves all Alert Definitions which are currently suspended
openAlertSettingsPanel()	`void`	Opens Settings Panel with Alert section selected and visible
showAlert(alertHeader, alertMessage, messageType, alertProperties)	`Promise<void>`	Creates Alert based on given parameters and displays it.
showAlertError(alertHeader, alertMessage)	`Promise<void>`	Creates an Adaptable Alert based on given parameters and displays it as Error Alert.
showAlertInfo(alertHeader, alertMessage)	`Promise<void>`	Creates an Adaptable Alert based on given parameters and displays it as Info Alert.
showAlertSuccess(alertHeader, alertMessage)	`Promise<void>`	Creates an Adaptable Alert based on given parameters and displays it as Succcess Alert.
showAlertWarning(alertHeader, alertMessage)	`Promise<void>`	Creates an Adaptable Alert based on given parameters and displays it as Warning Alert.
suspendAlertDefinition(alertDefinition)	`AlertDefinition`	Suspends Alert Definition
suspendAllAlertDefinition()	`void`	Suspends all Alert Definitions
unSuspendAlertDefinition(alertDefinition)	`AlertDefinition`	Activates a suspended Alert Definition
unSuspendAllAlertDefinition()	`void`	Activates all suspended Alert Definition

Method Details

addAlertDefinition

Adds given Alert Definition to Adaptable State

TypeScript

addAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;

Parameters

Parameter	Type	Description
alertDefinition	`AlertDefinition`	AlertDefinition to add

Returns

AlertDefinition

applyScheduledAlertDefinition

Fires a scheduled alert definition (notification, system status, etc.)

TypeScript

applyScheduledAlertDefinition(alertDefinition: AlertDefinition): void;

Parameters

Parameter	Type
alertDefinition	`AlertDefinition`

Returns

void

deleteAlertDefinition

Deletes given Alert Definition from Adaptable State

TypeScript

deleteAlertDefinition(alertDefinition: AlertDefinition): void;

Parameters

Parameter	Type	Description
alertDefinition	`AlertDefinition`

Returns

void

displayAdaptableAlert

Displays the given Adaptable Alert

TypeScript

displayAdaptableAlert(alertToShow: AdaptableAlert): Promise<void>;

Parameters

Parameter	Type
alertToShow	`AdaptableAlert`

Returns

Promise<void>

displayAdaptableAlertNotification

Displays given Alert as a Toast

TypeScript

displayAdaptableAlertNotification(alert: AdaptableAlert): void;

Parameters

Parameter	Type	Description
alert	`AdaptableAlert`	the Alert to show as a Toast

Returns

void

editAlertDefinition

Updates given Alert Definition in Adaptable State

TypeScript

editAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;

Parameters

Parameter	Type	Description
alertDefinition	`AlertDefinition`	Alert to Edit

Returns

AlertDefinition

evaluateAlertDefinitions

Evaluates the given Alert Definitions - will fire Alert if rule is met

TypeScript

evaluateAlertDefinitions(alertDefinitions: AlertDefinition[]): void;

Parameters

Parameter	Type	Description
alertDefinitions	`AlertDefinition[]`	Alert Definitions to evaluate

Returns

void

findAlertDefinitions

Find all Alert Definitions which match the given criteria

TypeScript

findAlertDefinitions(alertLookupCriteria: AdaptableObjectLookupCriteria): AlertDefinition[];

Parameters

Parameter	Type	Description
alertLookupCriteria	`AdaptableObjectLookupCriteria`	lookup criteria

Returns

AlertDefinition[]

getActiveAlertDefinitions

Retrieves all Alert Definitions which are currently active

TypeScript

getActiveAlertDefinitions(config?: LayoutExtendedConfig): AlertDefinition[];

Parameters

Parameter	Type
config	`LayoutExtendedConfig`

Returns

AlertDefinition[]

getAlertDefinitionById

Retrieves alert definition by the technical ID (from AlertState)

TypeScript

getAlertDefinitionById(id: AlertDefinition['Uuid'], config?: LayoutExtendedConfig): AlertDefinition;

Parameters

Parameter	Type	Description
id	`AlertDefinition['Uuid']`	alert definition id
config	`LayoutExtendedConfig`

Returns

AlertDefinition

getAlertDefinitionByName

Retrieves an Alert Definition by its Name

TypeScript

getAlertDefinitionByName(name: string): AlertDefinition | undefined;

Parameters

Parameter	Type	Description
name	`string`	Name of the Alert Definition

Returns

AlertDefinition | undefined

getAlertDefinitions

Retrieves all Alert Definitions in Alert State

TypeScript

getAlertDefinitions(config?: LayoutExtendedConfig): AlertDefinition[];

Parameters

Parameter	Type
config	`LayoutExtendedConfig`

Returns

AlertDefinition[]

getAlertState

Retrieves Alert section from Adaptable State

TypeScript

getAlertState(): AlertState;

Returns

AlertState

getSuspendedAlertDefinitions

Retrieves all Alert Definitions which are currently suspended

TypeScript

getSuspendedAlertDefinitions(config?: LayoutExtendedConfig): AlertDefinition[];

Parameters

Parameter	Type
config	`LayoutExtendedConfig`

Returns

AlertDefinition[]

openAlertSettingsPanel

Opens Settings Panel with Alert section selected and visible

TypeScript

openAlertSettingsPanel(): void;

Returns

void

showAlert

Creates Alert based on given parameters and displays it.

TypeScript

showAlert(alertHeader: string, alertMessage: string, messageType: AdaptableMessageType, alertProperties?: AlertPresentationProperties): Promise<void>;

Parameters

Parameter	Type	Description
alertHeader	`string`	Header of the Alert (if shown in a popup its the Title of the Window)
alertMessage	`string`	Main message of the alert
messageType	`AdaptableMessageType`
alertProperties	`AlertPresentationProperties`

Returns

Promise<void>

showAlertError

Creates an Adaptable Alert based on given parameters and displays it as Error Alert.

TypeScript

showAlertError(alertHeader: string, alertMessage: string): Promise<void>;

Parameters

Parameter	Type	Description
alertHeader	`string`	Header of the Alert (if shown in a popup its the Title of the Window)
alertMessage	`string`	Main message of the alert

Returns

Promise<void>

showAlertInfo

Creates an Adaptable Alert based on given parameters and displays it as Info Alert.

TypeScript

showAlertInfo(alertHeader: string, alertMessage: string): Promise<void>;

Parameters

Parameter	Type	Description
alertHeader	`string`	Header of the Alert (if shown in a popup its the Title of the Window)
alertMessage	`string`	Main message of the alert

Returns

Promise<void>

showAlertSuccess

Creates an Adaptable Alert based on given parameters and displays it as Succcess Alert.

TypeScript

showAlertSuccess(alertHeader: string, alertMessage: string): Promise<void>;

Parameters

Parameter	Type	Description
alertHeader	`string`	Header of the Alert (if shown in a popup its the Title of the Window)
alertMessage	`string`	Main message of the alert

Returns

Promise<void>

showAlertWarning

Creates an Adaptable Alert based on given parameters and displays it as Warning Alert.

TypeScript

showAlertWarning(alertHeader: string, alertMessage: string): Promise<void>;

Parameters

Parameter	Type	Description
alertHeader	`string`	Header of the Alert (if shown in a popup its the Title of the Window)
alertMessage	`string`	Main message of the alert

Returns

Promise<void>

suspendAlertDefinition

Suspends Alert Definition

TypeScript

suspendAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;

Parameters

Parameter	Type	Description
alertDefinition	`AlertDefinition`	Alert to suspend

Returns

AlertDefinition

suspendAllAlertDefinition

Suspends all Alert Definitions

TypeScript

suspendAllAlertDefinition(): void;

Returns

void

unSuspendAlertDefinition

Activates a suspended Alert Definition

TypeScript

unSuspendAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;

Parameters

Parameter	Type	Description
alertDefinition	`AlertDefinition`	Alert to Un-suspend (activate)

Returns

AlertDefinition

unSuspendAllAlertDefinition

Activates all suspended Alert Definition

TypeScript

unSuspendAllAlertDefinition(): void;

Returns

void

PreviousAgGridMenuItem NextAlertButton