Interface INotificationService

Service that sends notifications to users in the UI

interface INotificationService {
dismiss(notificationId: string | number): Promise<void>;
send(notification: PlatformNotification): Promise<string | number>;
}

Index

Methods

Methods

dismiss

dismiss(notificationId: string | number): Promise<void>
Dismiss a notification by its ID. If the notification is not found, this is a no-op.
Parameters
- notificationId: string | number
  ID of the notification to dismiss, as returned by send
Returns Promise<void>
- Defined in lib/papi-dts/papi.d.ts:4342

send

send(notification: PlatformNotification): Promise<string | number>
Send a notification to the user. If a notification with the same ID is already showing, it will be updated with the new notification.
Parameters
- notification: PlatformNotification
  Notification to send
Returns Promise<string | number>
Promise that resolves with the ID of the notification
- Defined in lib/papi-dts/papi.d.ts:4336