# OpenFin Technical Reference

Canonical page: https://www.adaptabletools.com/docs/technical-reference-openfin

## OpenFin Plugin Options

| Property | Type | Description | Default |
| --- | --- | --- | --- |
| [notificationTimeout](https://www.adaptabletools.com/docs/reference/openfinpluginoptions.md#notificationtimeout) | `number \| false` | Timeout (in ms) for OpenFin Notifications to expire; set false for notifications not to auto-dismiss | 5000 |
| [onNotificationAction](https://www.adaptabletools.com/docs/reference/openfinpluginoptions.md#onnotificationaction) | `(event: \{ notification: any; type: string; trigger: string; result: \{ task: string; \}; \}) => any` | Function which is invoked when a button in OpenFin notification is clicked |   |
| [onShowNotification](https://www.adaptabletools.com/docs/reference/openfinpluginoptions.md#onshownotification) | `(notification: any, alert?: `[`AdaptableAlert`](https://www.adaptabletools.com/docs/reference/adaptablealert.md)`) => any` | Updates OpenFin Notification object before it's displayed (just add/remove properties); return false to stop Notification showing |   |
| [onValidationFailureInExcel](https://www.adaptabletools.com/docs/reference/openfinpluginoptions.md#onvalidationfailureinexcel) | `'override' \| 'show-notification' \| 'show-undo-notification'` | Action to perform when a data change in Live Excel report triggers Prevent Edit Alert failure |   |
| [showAdaptableAlertsAsNotifications](https://www.adaptabletools.com/docs/reference/openfinpluginoptions.md#showadaptablealertsasnotifications) | `boolean` | Converts AdapTable Alerts configured to display in popup as OpenFin Notifications | true |
| [showAppIconInNotifications](https://www.adaptabletools.com/docs/reference/openfinpluginoptions.md#showappiconinnotifications) | `true` | Icon to show in Notification - uses the value supplied in UserInterfaceOptions | true |
| [throttleTime](https://www.adaptabletools.com/docs/reference/openfinpluginoptions.md#throttletime) | `number` | How long (in ms) AdapTable throttles when sending data update to OpenFin | 2000 |

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

## OpenFin API

Some of these methods are intended for **internal** use only - and have been marked as such

| Method | Returns | Description |
| --- | --- | --- |
| [getCurrentLiveOpenFinReport()](https://www.adaptabletools.com/docs/reference/openfinapi.md#getcurrentliveopenfinreport) | [`OpenFinReport`](https://www.adaptabletools.com/docs/reference/openfinreport.md)` \| undefined` | Retrieves the OpenFin currently sending live data to Excel |
| [getOpenFinState()](https://www.adaptabletools.com/docs/reference/openfinapi.md#getopenfinstate) | [`OpenFinState`](https://www.adaptabletools.com/docs/reference/openfinstate.md)` \| undefined` | Retrieves the OpenFin section of System State |
| [getOpenFinThrottleTime()](https://www.adaptabletools.com/docs/reference/openfinapi.md#getopenfinthrottletime) | `number \| undefined` | Retrieves the Throttle time for live updates |
| [getPluginOptions()](https://www.adaptabletools.com/docs/reference/openfinapi.md#getpluginoptions) | [`OpenFinPluginOptions`](https://www.adaptabletools.com/docs/reference/openfinpluginoptions.md) | Retrieves the OpenFinPlugOptions provided in OpenFin Plugin |
| [isOpenFinAvailable()](https://www.adaptabletools.com/docs/reference/openfinapi.md#isopenfinavailable) | `boolean` | Whether OpenFin is available |
| [isOpenFinRunning()](https://www.adaptabletools.com/docs/reference/openfinapi.md#isopenfinrunning) | `boolean` | Whether OpenFin is currently running |
| [showNotification(notification)](https://www.adaptabletools.com/docs/reference/openfinapi.md#shownotification) | `void` | Shows a notification in OpenFin |
| [showNotificationForAlert(alert)](https://www.adaptabletools.com/docs/reference/openfinapi.md#shownotificationforalert) | `void` | Displays Alert as an OpenFin Notification |
| [startLiveData(OpenFinReport)](https://www.adaptabletools.com/docs/reference/openfinapi.md#startlivedata) | `void` | Runs Report in Excel as Live Report (so updates as AdapTable ticks) |
| [stopLiveData()](https://www.adaptabletools.com/docs/reference/openfinapi.md#stoplivedata) | `void` | Stops live data; data will no longer be sent from AdapTable to Excel |

## Accessing the API

Because OpenFin is available via a Plugin, the easiest way to access the Api is as follows:

```ts
const openFinApi = adaptableApi.pluginsApi.getOpenFinPluginApi();
```