Class: NotificationClient

Advanced Notification Client (Finsemble Workspaces)

Used to send, receive and manipulate notifications

NOTE: The Notification UI is not currently integrated into Finsemble. To integrate the UI please follow the instructions here: https://github.com/ChartIQ/finsemble-notifications/releases/tag/5.1.0.

Methods

fetchHistory
(since, filter)

Fetches all the notifications sent to Finsemble after a specific date.

Name Type Description
since string

ISO8601 formatted date string to fetch notifications from.

filter IFilter
Name Type Description
exclude

An array of objects on which to exclude a notification. If more than one object is used it will use an OR match. Exclude takes precedence over Include

include

An array of objects. If more than one object is used it will use an OR match.

Examples

Get notifications sent between now and one month ago

let lastMonth = new Date();
lastMonth.setMonth(lastMonth.getMonth()-1);

const notifications = await FSBL.Clients.NotificationClient.fetchHistory(lastMonth.toISOString())

Get notifications sent between now and one month ago that matches a filter.


const lastMonth = new Date();
lastMonth.setMonth(lastMonth.getMonth()-1);

const filter = new FSBL.Clients.NotificationClient.Filter();

// include all notifications from the OMS
filter.include.push({"source":"order-management-system"})

// But exclude informational notifications from the OMS
filter.exclude.push({"source":"order-management-system", type:"informational"})
const notifications = await FSBL.Clients.NotificationClient.fetchHistory(lastMonth.toISOString(), filter)

getLastIssuedAt
(source)

Return an ISO8601 date a notification matching the specified source was issued. If no source is provided it will get the latest issue date for all notifications (i.e the last time any notification was issue to the service)

If you're sending notifications to Finsemble from an external source, you might want to know when the last Notification of that type was received by Finsemble, so you're able to send any pending ones to the user's desktop

Name Type Description
source string optional

to identify which notification to save lastUpdated time for.

Example
// Get the last date Finsemble received a notification sent with the source field set to "product-update-service"
const lastIssuedDate = await FSBL.Clients.NotificationClient.getLastIssuedAt("product-update-service")

markUnread
(notifications)

Sets the states of the isRead field to false.

All clients subscribed to received the updated notifications will be sent the new state.

Name Type Description
notifications INotification[]
Example
await FSBL.Clients.NotificationClient.markUnread([previouslyReceivedNotification]);

mute
(filter)

Sets a user preference on which notifications to mute. All future notifications that match the filter will have the mute flag set to true

Name Type Description
filter IMuteFilter
Name Type Description
source string optional
type string optional
Example
// Mute all notifications coming from the 'order-management-system' source with type 'informational'
await FSBL.Clients.NotificationClient.mute({
  source: "order-management-system",
  type: "informational"
});

notify
(notifications)

Send a new notification to Finsemble or update existing notifications already in Finsemble.

Name Type Description
notifications INotification[]

Array of INotification

Example

Send a new notification

const notification = new FSBL.Clients.NotificationClient.Notification();
// Set your notification fields accordingly
	notification.headerText = "You've Got Mail";
	notification.title = "Regarding Order...";
	notification.details = "Creates a new notification in UI";
	notification.type = "email";

await FSBL.Clients.NotificationClient.notify([notification]);

performAction
(notifications, action)

Tells the service to perform the supplied action on the notification(s)

Name Type Description
notifications INotification[]

Notifications to apply action to.

action IAction
Name Type Description
buttonText string

Text to display on the button UI.

channel string optional

Channel to transmit payload on QUERY, TRANSMIT and PUBLISH actions

component string optional

Component to spawn when using the spawn action.

id string

For Internal use

milliseconds number optional

Milliseconds to snooze for when using the snooze action

payload any optional

Payload transmitted along channel on QUERY, TRANSMIT and PUBLISH actions

spawnParams any optional

The spawnParams passed to the spawn function.

type string

DISMISS | SNOOZE | SPAWN | QUERY | PUBLISH | TRANSMIT

Example
 await FSBL.Clients.NotificationClient.performAction([notification], action).catch((e) => {
  console.log("Request to perform action failed");
});
// Request to perform action succeeded. The updated notification state will be broadcast to the subscribed clients

subscribe
(subscription, onNotification)

Subscribe to a notification stream given filters. Returns subscriptionId

Name Type Description
subscription ISubscription

TODO: Ensure this interface (or implemented type) is publicly accessible

Name Type Description
channel string optional

For Internal use

filter filter
id string

For Internal use

onNotification OnNotificationCallback

Defines the callback to and parameters pass into the onNotification function

Example
const { NotificationClient } = FSBL.Clients;
const subscription = new NotificationClient.Subscription();

// Set the filter to match INotification fields
subscription.filter = new NotificationClient.Filter();
// subscription.filter.include.push({"type": "chat"});

const onNotification = (notification: INotification) => {
 // This function will be called when a notification arrives
 addToList(notification);
};

// Use the subscription Id to unsubscribe from a specific subscription
const subscriptionId = await NotificationClient.subscribe(subscription, onNotification);

unmute
(filter)

Sets the filter preference on which notifications to mute. All future notifications that match the filter will have the mute flag set to true

Name Type Description
filter IMuteFilter
Name Type Description
source string optional
type string optional
Example
// Unmute all notifications coming from the 'order-management-system' source with type 'informational'
await FSBL.Clients.NotificationClient.unmute({
  source: "order-management-system",
  type: "informational"
});

unsubscribe
(subscriptionId)

Used to unsubscribe from a notification stream.

Name Type Description
subscriptionId string

which was returned when subscription was created.

Example
// the subscriptionId is returned from the subscribe function
await FSBL.Clients.NotificationClient.unsubscribe(subscriptionId);

unsubscribeAll
()

Unsubscribe from all notification streams registered with the window's client instance.

Example
FSBL.Clients.NotificationClient.unsubscribeAll();