System Status Message Technical Reference
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:
SystemStatusMessageDisplayedInfo
Payload of the SystemStatusMessageDisplayed event.
Fires when a System Status message is displayed.
Extends , so adaptableApi is included.
Message text, type (Success, Info, Warning or Error) and when it was sent.
Custom application Context provided in AdaptableOptions.adaptableContext
It is of type SystemStatusMessageInfo which is defined as follows:
SystemStatusMessageInfo
One message in the System Status panel.
statusMessage is the text. statusType is 'Success', 'Info', 'Warning' or 'Error' and sets the colour. statusFurtherInformation is optional extra text. timestamp is when it was raised.
string
Additional information to display (optional)
string
The Message to be displayed
Message type: Success, Info, Warning or Error
Date
When Message was sent
statusType is an AdapTable message type: Success, Info, Warning, or Error.
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
SystemStatusApi
Provides access to System Status Module and associated state
void
Deletes all System Status messages
SystemStatusMessageInfo | undefined
The System Status message currently on display.
void
Opens Settings Panel with System Status section selected and visible
Sets an Error System Status message.
Sets an Info System Status message.
Sets a Success System Status message.
Sets the System Status message shown in the System Status toolbar, tool panel and popup.
Sets a Warning System Status message.