Skip to content
This repository was archived by the owner on Sep 7, 2018. It is now read-only.

Notification API

Jump to bottom
Colin Eberhardt edited this page Mar 22, 2017 · 1 revision

See Notification API on the Symphony Confluence for more details.

The Notifications API is used to configure and display desktop notifications to the user. It is exposed as an extension to the HTML5 Notification API, providing additional functionality that is useful for financial desktop applications.

Initial Implementation

Current support

OpenFin, Electron and the browser have very different built-in notification capabilities:

  • Browser - notifications are a web API that is gaining support. However, for the Symphony API we are wanting to layer on additional functionality beyond what is made available via these APIs.
  • Electron - supports the Web notifications APIs, displaying them as OS notifications (e.g. notification centre on Mac). However, on Windows < 8, where the OS does not have built-in notification capabilities, Electron does not support notifications.
  • OpenFin - does not have any built-in notification capabilities.

Current implementation

  • Browser - This is a no-op, we are not planning to add the additional symphony functionality to the browser.
  • Electron - Within Electron the built-in Notification class is replaced with an alternative implementation that provides a notification via electron-notify. In the short-term, this provides notifications in Window 7, but more importantly illustrates how the built-in notifications can replaced with an alternative implementation.
  • OpenFin - The child-window functionality of OpenFin is used to provide notification functionality.

Clone this wiki locally