Interface NotificationRepository`Alpha`

Service for handling notifications

Hierarchy

NotificationRepository

Index

Methods

delete get loadAll markAsRead

Methods

delete

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

get

get(notificationId: number): Notification<unknown>
Get a loaded notification by its id

Returns
the fetched notification
Parameters
- notificationId: number
  
  the id of the notification to get
Returns Notification<unknown>

loadAll

loadAll(options?: NotificationLoadOptions): Promise<NotificationResponse>
Load all notifications belonging to the logged in user from the server

Returns
the saved notifications
Parameters
- Optional options: NotificationLoadOptions
  
  options to provide when loading notifications
Returns Promise<NotificationResponse>

markAsRead

markAsRead(notification: Notification<unknown>, read?: boolean): Promise<Notification<unknown>>
Mark a notification as read or unread

Returns
the updated notification
Parameters
- notification: Notification<unknown>
  
  the notification to update
- Optional read: boolean
  
  optional - whether the notification should be marked as read or unread. Defaults to true
Returns Promise<Notification<unknown>>