Lime Web Components API Documentation - v6.24.0
    Preparing search index...

    Interface Notifications

    Service for displaying different notification messages

    interface Notifications {
        alert(
            title: string,
            message: string,
            options?: AlertOptions,
        ): Promise<void>;
        confirm(
            title: string,
            message: string,
            options?: ConfirmOptions,
        ): Promise<boolean>;
        notify(message: string, options?: NotificationOptions): Promise<boolean>;
        report(message: string, options?: ReportOptions): Promise<boolean>;
    }
    Index

    Methods

    alert confirm notify report

    Methods

    • Display a blocking alert dialog

      Parameters

      • title: string

        title of the dialog

      • message: string

        message to display in the dialog

      • Optionaloptions: AlertOptions

      Returns Promise<void>

      a promise that will be resolved when the dialog is closed

    • Display a blocking confirm dialog

      Parameters

      • title: string

        title of the dialog

      • message: string

        message to display in the dialog

      • Optionaloptions: ConfirmOptions

      Returns Promise<boolean>

      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.

    • Display a non-blocking notification

      Parameters

      Returns Promise<boolean>

      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.

    • Display a non-blocking and non-transient message

      Parameters

      • message: string

        message to display in the banner

      • Optionaloptions: ReportOptions

      Returns Promise<boolean>

      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.

    Settings

    Member Visibility

    On This Page

    Methods