OpenFin Workspace API
    Preparing search index...

    Interface BaseUpdatableNotificationOptions<T>

    Configuration options for constructing an updatable Notifications object, shared between all templates.

    interface BaseUpdatableNotificationOptions<T extends keyof typeof TemplateNames> {
        buttons?: ButtonOptions[];
        customData?: CustomData;
        id: string;
        template?: T;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index
    buttons? customData? id template?
    buttons?: ButtonOptions[]

    A list of buttons to display below the notification text.

    Notifications support up to four buttons. Attempting to add more than four will result in the notification being rejected by the service.

    customData?: CustomData

    Application-defined context data that can be attached to buttons on notifications.

    When using forms, form data submitted will be written to customData and returned to your app by listening to the submit notification-action with the trigger ActionTrigger.SUBMIT|submit.

    id: string

    A unique identifier for the notification.

    Mandatory field for Notification updates.

    template?: T

    description of update type 'markdown', 'list' or 'custom'

    Settings

    On This Page
    Properties