System Status Message Technical Reference
Summary
- The System Status Message Displayed Event is fired whenever a System Status Message is displayed
- System Status Messages are dispatched using the SystemStatusAPI section of Adaptable API
System Status Message Displayed Event
The System Status Message Displayed Event is fired whenever a System Status Message is displayed.
The Event Info provides full details about:
- the Message
- the Message Type
- any further information that was included
- when the message was displayed
System Status Message Displayed Info
The SystemStatusMessageDisplayedInfo object provided by the event contains a single property:
| Property | Type | Description |
|---|---|---|
| systemStatusMessageInfo | SystemStatusMessageInfo | Details of the System Status Message and Type |
| adaptableContext | any | Custom application Context provided in AdaptableOptions.adaptableContext |
It is of type SystemStatusMessageInfo which is defined as follows:
| Property | Type | Description |
|---|---|---|
| statusFurtherInformation | string | Additional information to display (optional) |
| statusMessage | string | The Message to be displayed |
| statusType | AdaptableMessageType | Type of Message i.e. Succcess, Warning, Error, Info |
| timestamp | Date | When Message was sent |
Event Subscription
Subscribing to the Event is done the same way as with all Adaptable Events:
api.eventApi.on('SystemStatusMessageDisplayed', (eventInfo: SystemStatusMessageDisplayedInfo) => {
// do something with the info
});System Status API
The System Status API section of Adaptable API is primarily used to send System Status Messages:
| Method | Returns | Description |
|---|---|---|
| deleteAllSystemStatusMessages() | void | Deletes all System Status messages |
| getCurrentSystemStatusMessageInfo() | SystemStatusMessageInfo | undefined | Retrieves current System Status Message |
| openSystemStatusSettingsPanel() | void | Opens Settings Panel with System Status section selected and visible |
| setErrorSystemStatus(statusMessage, furtherInformation) | void | Sets an Error System Status Message |
| setInfoSystemStatus(statusMessage, furtherInformation) | void | Sets an Info System Status Message |
| setSuccessSystemStatus(statusMessage, furtherInformation) | void | Sets a Success System Status Message |
| setSystemStatus(statusMessage, messageType, statusFurtherInformation) | void | Sets a new System Status message; appears in System Status toolbar, tool panel (and popup). |
| setWarningSystemStatus(statusMessage, furtherInformation) | void | Sets a Warning System Status Message |