# System Status Message Technical Reference

Canonical page: https://www.adaptabletools.com/docs/technical-reference-system-status-message

## 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`](https://www.adaptabletools.com/docs/reference/systemstatusmessagedisplayedinfo.md) object provided by the event contains a single property:

| Property | Type | Description |
| --- | --- | --- |
| [systemStatusMessageInfo](https://www.adaptabletools.com/docs/reference/systemstatusmessagedisplayedinfo.md#systemstatusmessageinfo) | [`SystemStatusMessageInfo`](https://www.adaptabletools.com/docs/reference/systemstatusmessageinfo.md) | Message text, type (`Success`, `Info`, `Warning` or `Error`) and when it was sent. |
| [adaptableContext](https://www.adaptabletools.com/docs/reference/systemstatusmessagedisplayedinfo.md#adaptablecontext) | `any` | Custom application Context provided in `AdaptableOptions.adaptableContext` |

It is of type [`SystemStatusMessageInfo`](https://www.adaptabletools.com/docs/reference/systemstatusmessageinfo.md) which is defined as follows:

| Property | Type | Description |
| --- | --- | --- |
| [statusFurtherInformation](https://www.adaptabletools.com/docs/reference/systemstatusmessageinfo.md#statusfurtherinformation) | `string` | Additional information to display (optional) |
| [statusMessage](https://www.adaptabletools.com/docs/reference/systemstatusmessageinfo.md#statusmessage) | `string` | The Message to be displayed |
| [statusType](https://www.adaptabletools.com/docs/reference/systemstatusmessageinfo.md#statustype) | [`AdaptableMessageType`](https://www.adaptabletools.com/docs/reference/adaptablemessagetype.md) | Message type: `Success`, `Info`, `Warning` or `Error` |
| [timestamp](https://www.adaptabletools.com/docs/reference/systemstatusmessageinfo.md#timestamp) | `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](https://www.adaptabletools.com/docs/technical-reference-adaptable-events/index.md):

```ts
api.eventApi.on('SystemStatusMessageDisplayed', (eventInfo: SystemStatusMessageDisplayedInfo) => {
    // do something with the info
});
```

--------------

## System Status API

| Method | Returns | Description |
| --- | --- | --- |
| [deleteAllSystemStatusMessages()](https://www.adaptabletools.com/docs/reference/systemstatusapi.md#deleteallsystemstatusmessages) | `void` | Deletes all System Status messages |
| [getCurrentSystemStatusMessageInfo()](https://www.adaptabletools.com/docs/reference/systemstatusapi.md#getcurrentsystemstatusmessageinfo) | [`SystemStatusMessageInfo`](https://www.adaptabletools.com/docs/reference/systemstatusmessageinfo.md)` \| undefined` | The System Status message currently on display. |
| [openSystemStatusSettingsPanel()](https://www.adaptabletools.com/docs/reference/systemstatusapi.md#opensystemstatussettingspanel) | `void` | Opens Settings Panel with System Status section selected and visible |
| [setErrorSystemStatus(statusMessage, furtherInformation)](https://www.adaptabletools.com/docs/reference/systemstatusapi.md#seterrorsystemstatus) | `void` | Sets an Error System Status message. |
| [setInfoSystemStatus(statusMessage, furtherInformation)](https://www.adaptabletools.com/docs/reference/systemstatusapi.md#setinfosystemstatus) | `void` | Sets an Info System Status message. |
| [setSuccessSystemStatus(statusMessage, furtherInformation)](https://www.adaptabletools.com/docs/reference/systemstatusapi.md#setsuccesssystemstatus) | `void` | Sets a Success System Status message. |
| [setSystemStatus(statusMessage, messageType, statusFurtherInformation)](https://www.adaptabletools.com/docs/reference/systemstatusapi.md#setsystemstatus) | `void` | Sets the System Status message shown in the System Status toolbar, tool panel and popup. |
| [setWarningSystemStatus(statusMessage, furtherInformation)](https://www.adaptabletools.com/docs/reference/systemstatusapi.md#setwarningsystemstatus) | `void` | Sets a Warning System Status message. |