Class NotificationService

The notification service gives access to the user notifications on the project library cloud server.

Index

Constructors

Methods

getUnreadNotifications markAllAsReadBeforeDate markAsRead

Constructors

constructor

new NotificationService(): NotificationService

Returns NotificationService

Methods

`Static`getUnreadNotifications

getUnreadNotifications(
projectUUID?: UUID,
): UncertainAsyncOp<NotificationServiceNotification[], string>
Gets a list of unread notifications for the current user on the given projectUUI.
Parameters
- OptionalprojectUUID: UUID
  The UUID of the project to fetch all unread notifications from.
Returns UncertainAsyncOp<NotificationServiceNotification[], string>
An async op which will return all unread notifications of the current user on the project.

`Static`markAllAsReadBeforeDate

markAllAsReadBeforeDate(
dateString: string,
projectUUID?: UUID,
): UncertainAsyncOp<void, string>
Marks all user notifications before dateString on projectUUID as read.
Parameters
- dateString: string
  The date string that represents the date to mark everything as read before that date.
- OptionalprojectUUID: UUID
  The UUID of the project to mark the notification as read.
Returns UncertainAsyncOp<void, string>
An async op which will return once the server acknowledges the request.

`Static`markAsRead

markAsRead(
notificationUUID: UUID,
projectUUID?: UUID,
): UncertainAsyncOp<void, string>
Marks the given notificationUUID on projectUUID as read.
Parameters
- notificationUUID: UUID
  The UUID of the notification to be marked as read.
- OptionalprojectUUID: UUID
  The UUID of the project to mark the notification as read.
Returns UncertainAsyncOp<void, string>
An async op which will return once the server acknowledges the request.