Edge Documentation

{{DISPLAYTITLE:exampleAlertsWidget}}
[[Category:AppBoard 2.5]]

==Overview==

The exampleAlertsWidget is an example of how the HTML Widget API can be used for other purposes, not just visualizing data. It works by keeping track of data collection updates over multiple poll periods and testing whether certain conditions exist. If so then an alert is triggered which causes:

* an audible alarm to sound, this can be disabled by configuration, or muted by a user.
* a visual alert with configurable information.
* trigger AppBoard actions, which can be disabled by configuration. Actions are also triggered if going from an alert state back to non-alert state.

In the AppBoard Welcome archive the widget is in a stack of widgets which by default is showing a Status List. In the event of an alert, actions cause the alert widget to come to the foreground by using the ''Show Widget'' action. When the alert situation clears, another action is used to switch back to the Status List.


[[File:appboard-2.5-examplealertswidget.png|frame|center|exampleAlertsWidget from the AppBoard Welcome archive.]]

==Configuration==

[[File:appboard-2.5-examplealertswidget-configuration.png|frame|center|exampleAlertsWidget configuration page.]]