Namespace: types
services.notification.types
Enumerations
Classes
Interfaces
- IAction
- IFilter
- ILastIssued
- IMuteFilter
- INotificationClient
- INotificationService
- IPerformedAction
- ISnoozeTimer
- ISubscription
- NotificationsConfig
- OnNotificationCallback
- PurgeConfig
- ToggleComponent
- WindowConfig
References
Action
Re-exports Action
ActionTypes
Re-exports ActionTypes
Filter
Re-exports Filter
Notification
Re-exports Notification
Subscription
Re-exports Subscription
Type Aliases
INotification
Ƭ INotification: Object
description Interface to define what structure the Finsemble notification service is able to process
Type declaration
| Name | Type | Description |
|---|---|---|
actions? | (IAction | IAction[])[] | A list of Actions and/or Action Groups. An action can be a single action (IAction), or an action group (IAction[]). An action group is a collection of related actions grouped together as a single element. |
actionsHistory? | IPerformedAction[] | list of actions which have been performed on a notification. |
contentLogo? | string | Logo to display in content section of a notification.HTML source data URI or URL. Defaults set by type in configuration. |
cssClassName? | string | Allows a css class to be applied to a notification to change it's appearance. |
details? | string | Details about the notification mainly for display purposes. |
devModeOnly? | boolean | A flag to determine whether the notification is to be displayed only if Finsemble is running in dev mode. |
headerLogo? | string | Logo displayed in header section of a notification. HTML source data URI or URL. Defaults set by type in configuration. |
headerText? | string | An informational header additional to the title usually referencing the source. Deprecated: Not used since 5.3 and expected to be removed in version 6.0 deprecated - Not used in 5.3 and expected to be removed in version 6.0 |
id? | string | Either set when notification is created to refer to id an external system or if null set to UUID. |
isDeleted | boolean | Private: Indicating a notification has been deleted |
isMuted | boolean | Private: If a Notification has been muted after being received |
isRead | boolean | Private: If an notification has been marked as read. |
isSnoozed | boolean | Private: Indicating a notification is currently snoozed |
issuedAt | string | ISO8601 date formatted string. When the notification was generated. |
meta? | Meta | Additional metadata to be passed along with a notification. Supports arbitrary metadata fields. For example, a team may decide to include a Source or Channel field in all notifications to support filtering operations, or a Quote or Customer ID field to support grouping of notifications generated by different systems but relating to the same entity (for example for filtering/drill down in the Notification Center). |
notificationAlertSound? | string | - |
receivedAt? | string | Private: ISO8601 date formatted string. When the notification was received by Finsemble |
source? | string | The source that the notification originated from |
stateHistory | INotification[] | - |
timeout? | number | How long should the notification appear in the UIs. |
title | string | Main display title |
type? | string | The type of notification. |
INotificationHistoryOptions
Ƭ INotificationHistoryOptions: Object
Type declaration
| Name | Type | Description |
|---|---|---|
pageNumber? | number | The page number |
pageSize? | number | The number of notifications to fetch |
sentAfter? | string | ISO8601 date formatted string. Fetch (from) notifications sent after this date |
sentBefore? | string | ISO8601 date formatted string. Fetch (from) notifications sent before this date |
NotificationServiceState
Ƭ NotificationServiceState: Object
Type declaration
| Name | Type | Description |
|---|---|---|
mostRecentWindowName? | string | Contains the windowName of the most recent UI state change call. |
overFlowMenu | { clickCoordinates: boolean ; notification: boolean ; overflowCount: boolean } | - |
overFlowMenu.clickCoordinates | boolean | - |
overFlowMenu.notification | boolean | - |
overFlowMenu.overflowCount | boolean | - |
poppedOut | boolean | - |
position | number | - |
showCenter | boolean | - |
showDrawer | boolean | - |
toasterMonitor | string | - |