Package io.jmix.notifications.channel

Interface NotificationChannel

All Known Implementing Classes:
EmailNotificationChannel, InAppNotificationChannel
public interface NotificationChannel
Describes the way of notification sending.

Create String bean that implements this interface to support additional channel.

See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    Provides unique name of channel.
    boolean
    send(Notification notification)
    Sends provided notification via this notification channel.

  • Method Details

    • getName

      String getName()
      Provides unique name of channel.
      Returns:
      channel name

    • send

      boolean send(Notification notification)
      Sends provided notification via this notification channel.
      Parameters:
      notification - notification
      Returns:
      true if notification was successfully sent, false otherwise