Class Messages

The messages class displays messages of different types (info, error) to the user.

Hierarchy

  • Messages

Constructors

constructor

Methods

confirm error info

Constructors

constructor

Methods

Static confirm

  • Displays a confirm message. If the user confirms (user has clicked on the primary button), the promise returns an object with the id 'confirm'; otherwise the user canceled the confirm dialog.

    Parameters

    • message: string
    • Optional title: string

      The title of the message.

    • Optional primaryCommand: string

      The label of the confirm button.

    • Optional secondaryCommand: string

    Returns Promise<{ id: string }>

Static error

  • Displays an error message.

    Parameters

    • msg: string

      The message body.

    • Optional title: string

      [optional] the title of the message; if not provided, the title gets the default value "error" (in the current language).

    Returns Promise<void>

Static info

  • Displays an info message.

    Parameters

    • msg: string

      The message body.

    • Optional title: string

      [optional] the title of the message; if not provided, the title gets the default value "info" (in the current language).

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc