Class NotificationService<NotificationType>

An implementation of the FIN Notification service.

Type Parameters

NotificationType extends Notification = Notification

Index

Constructors

Methods

create dismiss make poll readAll readAllCurrentFiltered readAllTopics readByTopicFilter resolve

Constructors

constructor

new NotificationService<NotificationType extends Notification = Notification>(
serviceConfig: ClientServiceConfig,
): NotificationService<NotificationType>
Constructs a new notifications service object.
Type Parameters
- NotificationType extends Notification = Notification
Parameters
- serviceConfig: ClientServiceConfig
  Service configuration.
Returns NotificationService<NotificationType>
- Defined in src/client/notifications/NotificationService.ts:65

Methods

create

create(notification: NotificationType): Promise<HRef>
This operations will only be valid if the current user has write access to the notification targetApp and to the project the notification is stored in. Super users are allowed to post any notification, including system ones.
Parameters
- notification: NotificationType
  The notification object
Returns Promise<HRef>
The filtered notifications.
- Defined in src/client/notifications/NotificationService.ts:170

dismiss

dismiss(id: string | HRef): Promise<NotificationType>
Marks the state of notification state as dismissed.
Parameters
- id: string | HRef
  The notification ID to dismiss
Returns Promise<NotificationType>
The notification object
- Defined in src/client/notifications/NotificationService.ts:230

make

make(callbacks: NotificationEventHandler[]): Promise<NotificationsHandler>
Parameters
- callbacks: NotificationEventHandler[]
Returns Promise<NotificationsHandler>
- Defined in src/client/notifications/NotificationService.ts:70

poll

poll(timeOfLastMod: HDateTime): Promise<NotificationType[]>
Get all the new notifications in the system for the current user.
Parameters
- timeOfLastMod: HDateTime
  Time of the last modification.
Returns Promise<NotificationType[]>
New notifications since timeOfLastMod
- Defined in src/client/notifications/NotificationService.ts:190

readAll

readAll(): Promise<NotificationType[]>
Get all the notifications in the system for the current user

Returns Promise<NotificationType[]>
The result of the read operation.
- Defined in src/client/notifications/NotificationService.ts:87

readAllCurrentFiltered

readAllCurrentFiltered(filter?: string): Promise<NotificationType[]>
Get all notifications in the system for the current user filtered according to the user notification settings.
Parameters
- Optionalfilter: string
  A haystack filter
Returns Promise<NotificationType[]>
The result of the read operation.
- Defined in src/client/notifications/NotificationService.ts:125

readAllTopics

readAllTopics(): Promise<HStr[]>
Get notification topics that are visible to the current user

Returns Promise<HStr[]>
The result of the read operation.
- Defined in src/client/notifications/NotificationService.ts:105

readByTopicFilter

readByTopicFilter(filter?: string): Promise<NotificationType>
Get notifications for a topic that are visible to the current user
Parameters
- Optionalfilter: string
  A haystack filter
Returns Promise<NotificationType>
The filtered notifications.
- Defined in src/client/notifications/NotificationService.ts:147

resolve

resolve(id: string | HRef): Promise<NotificationType>
Marks the state of notification with the specified id as resolved.
Parameters
- id: string | HRef
  The notification ID to resolve
Returns Promise<NotificationType>
The notification object
- Defined in src/client/notifications/NotificationService.ts:210