Get started with Notification Center

OpenFin Notification Center includes an API that lets you create and organize uniform desktop notifications. Notifications can enhance users' experience with an OpenFin application, and ensure their attention is drawn to pertinent and actionable tasks.

The Notification Center application organizes notifications into a central location for ease of access. Users can discover their notifications through search or by sorting according to date and time or priority. The Notification Center app ships along side your application when included in your project and is accessible via a Notification icon in the Windows System Tray.

Users can configure desktop level settings, such as location of notifications and notification toasts. In Workspace version 9.1 and later, they can also choose to display notifications and toasts on secondary monitors. In previous versions, notifications were available only on the default monitor.

Use this API and the Notification Center app to:

  • Create persistent notification toasts
  • Attach event handlers for click or close events
  • Launch OpenFin applications currently hidden or closed on the desktop
  • Style a notification’s content with markdown and images
  • Create small forms to collect user responses

System requirements

Set up

Add the package as a dependency for your app:
> npm install openfin-notifications

📘

Note

  • The npm library is updated when the API is changed.
  • Updating the npm library does not update the version of the Notification Center app.

Usage

Create a basic notification

Once your app has the library installed, you can create a simple notification with title, body, and category properties. Copy and paste the following code into your app, and call it.

import {create} from 'openfin-notifications'; 

create({
  title: 'Hello!', 
  body: 'This is your first notification', 
  category: 'Greetings', 
})

For more details, refer to Buttons within a notification.

Refer to the articles under Notification styles for information about features you can use in notifications.


Did this page help you?