Skip to main content

Layouts v1, FDC3, and Notifications APIs

18-Sep-2020

This notice is to inform you of changes Here™ is implementing.

  • End-of-Life for the Layouts v1 API which has been replaced by the Platform API. The Platform API includes more advanced layouts capabilities and significantly improves on the Layouts v1 API.

    • Final Runtime Version supported is 15.80.50.34

    • End of Support Date is May 9, 2021

  • Change-of-Life-Cycle for our Notifications and FDC3 APIs which will no longer be managed as services.

    • Service life-cycle for both APIs will no longer be supported as of March 1, 2021

  • Deprecation of fin.Notifications legacy API which is being replaced by the Notifications API.

    • Marked as Deprecated in Runtime version 17.85.55.*

    • End of support as of March 1, 2021

Who is impacted?​

Application providers leveraging any of the following Here COre APIs:

Why are these changes happening?​

These changes are being made in response to broad customer feedback. A summary of each is below. Please don’t hesitate to contact us if you’d like additional information.

Layouts​

The Layouts v1 API has been replaced with our Platform API (previously known as Layouts API 2.0). This change is being made to:

  • Significantly improve performance and maintainability

  • Provide default tab support, customization, and complex layout support

  • Correctly integrate with standard Operating System functions such as Alt + Tab Preview, Move + Left/Right arrow keys, and z-order

DC3​

The FDC3 API now ships by default with the Runtime and does not need to be invoked as a service. This has the following benefits:

  • FDC3 API is versioned in tandem with the other Here Core APIs

  • Simplified app upgrade process: FDC3 API changes can be made and tested once as part of upgrading the Runtime version

  • Eliminates conflicts from different apps using different versions of the service

  • Eliminates conflicts from compatibility issues between Runtime versions and service versions

Notifications​

The Notifications Center’s lifecycle will be managed by the Notifications API and will no longer need to be invoked as a service as of version 1.0, which is scheduled for release in Q4 2020. This change is being made to:

  • Avoid visual collisions from multiple versions of Notification Center on the same desktop

  • Enable desktop owners to control the version of Notification Center for both internal and 3rd-party apps

fin.Notification​

The fin.Notification API has been superseded by the Notification API. This change is being made to:

  • Significantly improve end user experience when more than one application is generating notifications

  • Provide visual consistency and customization across notifications

  • Keep notifications history available to end users

What do you need to do?​

Application providers should migrate as soon as possible. In all cases, we are here to help and assist teams with their migration plans.

Layouts v1 API​

FDC3 API​

  • Add the FDC3 API to your application and remove the FDC3 service from your application manifest as part of upgrading to Here Core 17.85.55.* and beyond.

Notifications API​

  • Remove the Notifications Ssrvice declaration from your application manifest as part of migrating to a version of the OpenFin-Notifications NPM package that supports the new lifecycle management. (Version 1.0+, release date Q4 2020).

fin.Notification API​

Can my applications continue to use Here™ services and the fin.Notification API?​

Yes — Here™ strongly advises all customers to move to the respective alternative approaches as soon as practicable. If continuing to use the services and the fin.Notification API, be advised that no patches will be applied for any discovered bugs and any Chromium Security patches must be consumed in later versions of Here Core.

Table of Contents