Package com.flowable.engage.engine.impl.message

Interface MessageSendHelper

All Known Implementing Classes:

DefaultMessageSendHelper

public interface MessageSendHelper

Author:

Filip Hrisafov

See Also:

DefaultMessageSendHelper

Method Summary

Modifier and Type	Method	Description
String	renderMainContent(Conversation conversation, String receivingUserId, String messageKey, String messageCode, String messageLanguage, Map<String,Object> messagePayload)	Render the content of the template
void	scheduleTemporaryMessageHandling(TemporaryMessage temporaryMessage)	Schedule the temporary message handling.
boolean	shouldHandleAsTemporaryMessage(Message message, Conversation conversation)	Check whether the message should be handled as a temporary message.
default boolean	shouldIncreaseUnreadMessageCount(Message message, Conversation conversation)	Check whether the unread message count within the given conversation should be inreased for the given message
default boolean	shouldUpdateConversationLastMessageTime(Message message, Conversation conversation)	Check whether the message should trigger an update of the last message time of the conversation.

Method Detail

shouldHandleAsTemporaryMessage

boolean shouldHandleAsTemporaryMessage(Message message,
                                       Conversation conversation)

Check whether the message should be handled as a temporary message.

Parameters:

message - the message

conversation - the conversation

Returns:

true if the message should be handled as a temporary message, false otherwise

scheduleTemporaryMessageHandling

void scheduleTemporaryMessageHandling(TemporaryMessage temporaryMessage)

Schedule the temporary message handling.

Parameters:

temporaryMessage - the temporary message

shouldUpdateConversationLastMessageTime

default boolean shouldUpdateConversationLastMessageTime(Message message,
                                                        Conversation conversation)

Check whether the message should trigger an update of the last message time of the conversation.

Parameters:

message - the message

conversation - the conversation

Returns:

true when last message time of the conversation should be updated, false otherwise

shouldIncreaseUnreadMessageCount

default boolean shouldIncreaseUnreadMessageCount(Message message,
                                                 Conversation conversation)

Check whether the unread message count within the given conversation should be inreased for the given message

Parameters:

message - the message

conversation - the conversation

Returns:

true when the unread message count should be increased, false otherwise

renderMainContent

String renderMainContent(Conversation conversation,
                         String receivingUserId,
                         String messageKey,
                         String messageCode,
                         String messageLanguage,
                         Map<String,Object> messagePayload)

Render the content of the template

Parameters:

conversation - the conversation where the message is sent to

receivingUserId - the optional user id which receives the message.

messageKey - the template key of the message template to be used

messageCode - the message code to choose the template variation for

messageLanguage - the optional language (e.g. "en") for which the message should be rendered. If language is null the default language TemplateMessageUtil.FALLBACK_LANGUAGE is used.

messagePayload - the optional payload containing the necessary parameters (if any needed by the template)

Returns:

the content of the template