Alert API

Provides run-time access to the Alert function and Alert State.

Alert API Methods

MethodDescription
displayAlert(alertToShow)Displays (fully formed) inputted Alert to the User
displayMessageAlertPopup(alertToDisplay)Displays given Alert as a Popup
editAlert(alertDefinition)Edits Alert in State with given one
getAlertDefinitions()Retrieves all Alert Definitions in Alert State
getAlertPredicateDefs()Retrieves all Predicate Defs with Function Scope of Alert
getAlertPredicateDefsForScope(scope)Retrieves all Predicate Defs that match given Scope
getAlertState()Retrieves Alert section from Adaptable State
showAlert(alertHeader, alertMessage, alertDefinition, dataChangedInfo)Creates Alert formed from inputted values and displays it.
showAlertError(alertHeader, alertMessage)Creates Alert formed from inputted values and displays it as Error Alert.
showAlertInfo(alertHeader, alertMessage)Creates Alert formed from inputted values and displays it as Info Alert.
showAlertPopup()Opens the Alert popup screen
showAlertSuccess(alertHeader, alertMessage)Creates Alert formed from inputted values and displays it as Succcess Alert.
showAlertWarning(alertHeader, alertMessage)Creates Alert formed from inputted values and displays it as Warning Alert.

See API documentation for full details of all available functions with lists of parameters

More Information