Interface AlertManager

All Known Implementing Classes:
AlertManagerImpl

public interface AlertManager
Manages Alerts (using the AlertStorage SSO. The behavior of the service switches during an Ajax request to directly add JavaScript to present the alerts.
Since:
5.3
  • Method Details

    • success

      void success(String message)
      Adds an Severity.SUCCESS alert with the default duration, Duration.SINGLE.
      Parameters:
      message - to present to the user
      Since:
      5.3.6
    • info

      void info(String message)
      Adds an Severity.INFO alert with the default duration, Duration.SINGLE.
      Parameters:
      message - to present to the user
    • warn

      void warn(String message)
      Adds an Severity.WARN alert with the default duration, Duration.SINGLE.
      Parameters:
      message - to present to the user
    • error

      void error(String message)
      Adds an Severity.ERROR alert with the default duration, Duration.SINGLE.
      Parameters:
      message - to present to the user
    • alert

      void alert(Duration duration, Severity severity, String message)
      Adds an alert with configurable severity and duration. Message isn't treated as HTML, being HTML-escaped.
      Parameters:
      duration - controls how long the alert is presented to the user
      severity - controls how the alert is presented to the user
      message - to present to the user
    • alert

      @IncompatibleChange(details="Added in 5.4 in order to support HTML in alerts", release="5.4") void alert(Duration duration, Severity severity, String message, boolean markup)
      Adds an alert with configurable severity and duration.
      Parameters:
      duration - controls how long the alert is presented to the user
      severity - controls how the alert is presented to the user
      message - to present to the user
      markup - whether to treat the message as raw HTML (true) or escape it (false).