Package com.flowable.platform.notification.api

Class BaseNotification

java.lang.Object
com.flowable.platform.notification.api.BaseNotification
All Implemented Interfaces:
Notification
public class BaseNotification
extends java.lang.Object
implements Notification

  • Field Summary

    Fields 
    Modifier and Type Field Description
    protected boolean desktopNotification  
    protected java.lang.String messageType  
    protected boolean mobileNotification  

  • Constructor Summary

    Constructors 
    Constructor Description
    BaseNotification​(java.lang.String messageType)  
    BaseNotification​(java.lang.String messageType, boolean desktopNotification, boolean mobileNotification)  

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getMessageType()
    The type of the message that this notification belongs to.
    boolean isDesktopNotification()
    true if a desktop notification is needed.
    boolean isMobileNotification()
    true if a mobile notification is needed.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Constructor Details

    • BaseNotification

      public BaseNotification​(java.lang.String messageType)

    • BaseNotification

      public BaseNotification​(java.lang.String messageType, boolean desktopNotification, boolean mobileNotification)

  • Method Details

    • getMessageType

      public java.lang.String getMessageType()
      Description copied from interface: Notification
      The type of the message that this notification belongs to.
      Specified by:
      getMessageType in interface Notification
      Returns:
      the message type

    • isDesktopNotification

      public boolean isDesktopNotification()
      Description copied from interface: Notification
      true if a desktop notification is needed. This flag will only be set, if sent as a real time data object and not when loaded from the database. If received over the real time channel in a web- or desktop client and set to true, the client should show a notification. A value of null or false means to not show a desk notification.
      Specified by:
      isDesktopNotification in interface Notification
      Returns:
      returns true if the web- or desktop client should show a notification when received

    • isMobileNotification

      public boolean isMobileNotification()
      Description copied from interface: Notification
      true if a mobile notification is needed. This flag will only be set, if sent as a real time data object and not when loaded from the database. If received over the real time channel in a mobile client and set to true, the client should show a notification. A value of null or false means to not show a mobile notification. If a recipient receiving a message object with this flag set to true and not being online, a mobile push notification should be sent, if the recipient has a mobile device registered.
      Specified by:
      isMobileNotification in interface Notification
      Returns:
      returns true if the web- or desktop client should show a notification when received