Interface NotificationRepository`Beta`

Service for handling notifications

interface NotificationRepository {
    delete(notification: Notification): Promise<void>;
    get(notificationId: number): Notification;
    loadAll(options?: NotificationLoadOptions): Promise<NotificationResponse>;
    markAsRead(
        notification: Notification,
        read?: boolean,
    ): Promise<Notification>;
}

Index

Methods

delete get loadAll markAsRead

Methods

delete

delete(notification: Notification): Promise<void>
Beta
Delete a notification
Parameters
- notification: Notification
  the notification to delete
Returns Promise<void>

get

get(notificationId: number): Notification
Beta
Get a loaded notification by its id
Parameters
- notificationId: number
  the id of the notification to get
Returns Notification
the fetched notification

loadAll

loadAll(options?: NotificationLoadOptions): Promise<NotificationResponse>
Beta
Load all notifications belonging to the logged in user from the server
Parameters
- Optionaloptions: NotificationLoadOptions
  options to provide when loading notifications
Returns Promise<NotificationResponse>
the saved notifications

markAsRead

markAsRead(notification: Notification, read?: boolean): Promise<Notification>
Beta
Mark a notification as read or unread
Parameters
- notification: Notification
  the notification to update
- Optionalread: boolean
  optional - whether the notification should be marked as read or unread. Defaults to true
Returns Promise<Notification>
the updated notification