AlertPresentationProperties

View as Markdown

Notification properties shared by rule-based and scheduled alerts

TypeScript
export interface

Properties

PropertyTypeDescription
DisplayNotificationbooleanDisplays a notification when Alert is triggered
DisplaySystemStatusMessagebooleanShows the alert message in the System Status panel
LogToConsolebooleanLogs the Alert message to the console
NotificationDurationNotificationsOptions['duration']How long the notification stays visible. When omitted, notificationsOptions.duration is used.
ShowInDivbooleanShows the alert text in the element named by containerOptions.alertContainer

Property Details

DisplayNotification

Displays a notification when Alert is triggered

TypeScript
DisplayNotification?: boolean;
Property Value

boolean

DisplaySystemStatusMessage

Shows the alert message in the System Status panel

TypeScript
DisplaySystemStatusMessage?: boolean;
Property Value

boolean

LogToConsole

Logs the Alert message to the console

TypeScript
LogToConsole?: boolean;
Property Value

boolean

NotificationDuration

How long the notification stays visible. When omitted, notificationsOptions.duration is used.

TypeScript
NotificationDuration?: NotificationsOptions['duration'];
Property Value

NotificationsOptions['duration']

ShowInDiv

Shows the alert text in the element named by containerOptions.alertContainer

TypeScript
ShowInDiv?: boolean;
Property Value

boolean