Interface Notifications

Service for displaying different notification messages

Hierarchy

Notifications

Index

Methods

alert confirm notify report

Methods

alert

alert(title: string, message: string, options?: AlertOptions): Promise<void>
Display a blocking alert dialog

Returns
a promise that will be resolved when the dialog is closed
Parameters
- title: string
  
  title of the dialog
- message: string
  
  message to display in the dialog
- Optional options: AlertOptions
Returns Promise<void>

confirm

confirm(title: string, message: string, options?: ConfirmOptions): Promise<boolean>
Display a blocking confirm dialog

Returns
a promise that will be resolved to true when the dialog is closed. If the accepting button was pressed, the promise will resolve to true. Otherwise, the promise will resolve to false.
Parameters
- title: string
  
  title of the dialog
- message: string
  
  message to display in the dialog
- Optional options: ConfirmOptions
Returns Promise<boolean>

notify

notify(message: string, options?: NotificationOptions): Promise<boolean>
Display a non-blocking notification

Returns
a promise that will be resolved when the notification is closed. If the notification has an action button and it was pressed, the promise will resolve to true. Otherwise, the promise will resolve to false.
Parameters
- message: string
  
  message to display in the notification
- Optional options: NotificationOptions
Returns Promise<boolean>

report

report(message: string, options?: ReportOptions): Promise<boolean>
Display a non-blocking and non-transient message

Returns
a promise that will be resolved when the notification is closed. If the notification has an action button and it was pressed, the promise will resolve to true. Otherwise, the promise will resolve to false.
Parameters
- message: string
  
  message to display in the banner
- Optional options: ReportOptions
Returns Promise<boolean>