Package com.flowable.engage.api.notification

Interface NotificationInfo

All Known Implementing Classes:
NotificationInfoImpl
public interface NotificationInfo
Holder for the information required for sending a notification to the user.
Author:
Filip Hrisafov

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getUserId()
    The id of the user to which the notificiation needs to be sent
    boolean
    isDesktopNotification()
    Whether the given user needs to receive a desktop notification.
    boolean
    isMarkAsRead()
    Whether the message should be marked as read after sending the notification
    boolean
    isMobileNotification()
    Whether a mobile notification is needed for the user.

  • Method Details

    • getUserId

      String getUserId()
      The id of the user to which the notificiation needs to be sent
      Returns:
      the id of the user

    • isDesktopNotification

      boolean isDesktopNotification()
      Whether the given user needs to receive a desktop notification. This does not affect the real time messaging. If a user is connected a notification will always be send to him / her.
      Returns:
      whether a desktop notifications needs to be displayed

    • isMobileNotification

      boolean isMobileNotification()
      Whether a mobile notification is needed for the user.
      Returns:
      whether a mobile notification needs to be send

    • isMarkAsRead

      boolean isMarkAsRead()
      Whether the message should be marked as read after sending the notification
      Returns:
      whether the message should be marked as read