com.flowable.platform.notification.api

Interface Notification

All Known Implementing Classes:

BaseNotification

public interface Notification

Notification flags that provide information for sending messages

Author:

Filip Hrisafov

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

getMessageType

String getMessageType()

The type of the message that this notification belongs to.

Returns:

the message type

isDesktopNotification

boolean isDesktopNotification()

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.

Returns:

returns true if the web- or desktop client should show a notification when received

isMobileNotification

boolean isMobileNotification()

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.

Returns:

returns true if the web- or desktop client should show a notification when received