Interface LogAlert

  • All Known Implementing Classes:
    LogAlert

    public interface LogAlert
    A LogAlert represents a message that should be displayed to the user.

    Note: Only for implementation by Core, not plugins.

    Since:
    3.1.1.1
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int LT_ERROR
      Log Type: Error
      static int LT_INFORMATION
      Log Type: Information
      static int LT_WARNING
      Log Type: Warning
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.Object[] getContext()
      Returns the objects associated with the alert - this will return null if the alert isn't associated with such any objects.
      java.lang.Throwable getError()
      Returns the error associated with the alert - null if there is no error.
      int getGivenTimeoutSecs()
      How long should to display the alert for - this will be the value that was given when creating the alert.
      java.lang.String getPlainText()
      Returns the text of the message - this will have any formatting stripped out.
      java.lang.String getText()
      Returns the text of the message - this may include formatting tags (for example, hyperlinks).
      int getTimeoutSecs()
      How long should to display the alert for - this will be either the explicit value given when creating the alert, or a value determined from the client's behaviour and its configuration settings.
      int getType()
      Returns the log type of the alert - the value of which will be one of the LT_ constants defined above.
    • Method Detail

      • getGivenTimeoutSecs

        int getGivenTimeoutSecs()
        How long should to display the alert for - this will be the value that was given when creating the alert.
        Returns:
        How long to display the timeout for - -1 for no explicit value, 0 to display it indefinitely, otherwise it is the number of seconds to display the value for.
      • getTimeoutSecs

        int getTimeoutSecs()
        How long should to display the alert for - this will be either the explicit value given when creating the alert, or a value determined from the client's behaviour and its configuration settings.
        Returns:
        How long to display the timeout for - 0 to display it indefinitely, otherwise it is the number of seconds to display the value for.
      • getText

        java.lang.String getText()
        Returns the text of the message - this may include formatting tags (for example, hyperlinks).
        Returns:
        The text to display.
      • getPlainText

        java.lang.String getPlainText()
        Returns the text of the message - this will have any formatting stripped out.
        Returns:
        The text to display.
      • getError

        java.lang.Throwable getError()
        Returns the error associated with the alert - null if there is no error.
      • getType

        int getType()
        Returns the log type of the alert - the value of which will be one of the LT_ constants defined above.
      • getContext

        java.lang.Object[] getContext()
        Returns the objects associated with the alert - this will return null if the alert isn't associated with such any objects.