Interface AlertChannel

All Known Implementing Classes:
BasicAlertChannel, MailAlertChannel, WebAlertChannel

public interface AlertChannel
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the description of the AlertChannel.
    Returns the icon of the AlertChannel.
    getLabel(String userLang)
    Returns the label of the AlertChannel.
    Returns the internal name of the AlertChannel.
    boolean
    Returns true if this AlertChannel is available for the given Member.
    boolean
    Returns true if the alerts of this channel must be saved.
    void
    send(Alert alert)
    Sends an alert.
  • Method Details

    • getName

      String getName()
      Returns the internal name of the AlertChannel.
      Returns:
      the internal name of the AlertChannel.
      Since:
      jcms-8.0.0
    • getLabel

      String getLabel(String userLang)
      Returns the label of the AlertChannel.
      Parameters:
      userLang - the user language.
      Returns:
      the label of the AlertChannel.
      Since:
      jcms-8.0.0
    • getDescription

      String getDescription(String userLang)
      Returns the description of the AlertChannel.
      Parameters:
      userLang - the user language.
      Returns:
      the description of the AlertChannel.
      Since:
      jcms-8.0.0
    • getIcon

      String getIcon()
      Returns the icon of the AlertChannel.
      Returns:
      the icon of the AlertChannel.
      Since:
      jcms-8.0.0
    • isAvailable

      boolean isAvailable(Member member)
      Returns true if this AlertChannel is available for the given Member.
      Parameters:
      member - the member
      Returns:
      true if this AlertChannel is available for the given Member.
      Since:
      jcms-8.0.0
    • send

      void send(Alert alert)
      Sends an alert.
      Parameters:
      alert - the alert
      Since:
      jcms-8.0.0
    • saveAlert

      boolean saveAlert()
      Returns true if the alerts of this channel must be saved.
      Returns:
      true if the alerts of this channel must be saved.
      Since:
      jcms-8.0.0