Class: Notification

Notification

A Notification object represents a window on OpenFin Runtime which is shown briefly to the user on the bottom-right corner of the primary monitor. A notification is typically used to alert the user of some important event which requires his or her attention. Notifications are a child or your application that are controlled by the runtime.

Deprecated:

fin.Notification has been deprecated and replaced with the Notifications API. Please migrate to the Notifications API.

Methods

(static) create(options) → {_Notification}

Creates a new Notification.

Parameters:

Name	Type	Description
`options`	object

Deprecated:

Please migrate to the Notifications API.

Tutorials:

Notification.create

Returns:

Type: _Notification

(async) close() → {Promise.<void>}

Closes the notification

Deprecated:

Please migrate to the Notifications API.

Tutorials:

Notification.close

Returns:

Type: Promise.<void>

(async) sendMessage(message) → {Promise.<void>}

Sends a message to the notification.

Parameters:

Name	Type	Description
`message`	any	The message to be sent to the notification. Can be either a primitive data type (string, number, or boolean) or composite data type (object, array) that is composed of other primitive or composite data types

Deprecated:

Please migrate to the Notifications API.

Tutorials:

Notification.sendMessage

Returns:

Type: Promise.<void>

(async) show() → {Promise.<void>}

Invoked when the notification is shown

Deprecated:

Please migrate to the Notifications API.

Tutorials:

Notification.show

Returns:

Type: Promise.<void>