OpenFinPluginOptions

Options required for when using the OpenFin plugin

export interface

Properties

Property Details

notificationTimeout

Timeout (in ms) for OpenFin Notifications to expire; set false for notifications not to auto-dismiss

notificationTimeout?: number | false;

Default Value

5000

Property Value

number | false

onNotificationAction

Function which is invoked when a button in OpenFin notification is clicked

onNotificationAction?: (event: {
        notification: any;
        type: string;
        trigger: string;
        result: {
            task: string;
        };
    }) => any;

Property Value

(event: \{ notification: any; type: string; trigger: string; result: \{ task: string; \}; \}) => any

onShowNotification

Updates OpenFin Notification object before it's displayed (just add/remove properties); return false to stop Notification showing

onShowNotification?: (notification: any, alert?: AdaptableAlert) => any;

Property Value

(notification: any, alert?:AdaptableAlert) => any

onValidationFailureInExcel

Action to perform when a data change in Live Excel report triggers Prevent Edit Alert failure

onValidationFailureInExcel?: 'override' | 'show-notification' | 'show-undo-notification';

Property Value

'override' | 'show-notification' | 'show-undo-notification'

showAdaptableAlertsAsNotifications

Converts AdapTable Alerts configured to display in popup as OpenFin Notifications

showAdaptableAlertsAsNotifications?: boolean;

Default Value

true

Property Value

boolean

showAppIconInNotifications

Icon to show in Notification - uses the value supplied in UserInterfaceOptions

showAppIconInNotifications?: true;

Default Value

true

Property Value

true

throttleTime

How long (in ms) AdapTable throttles when sending data update to OpenFin

throttleTime?: number;

Default Value

2000

Property Value

number