com.flowable.engage.message.api

Interface MessageService

All Known Implementing Classes:

MessageServiceImpl

public interface MessageService

Author:

Filip Hrisafov

Method Summary

Modifier and Type	Method and Description
MessageBuilder	createMessageBuilder()
MessageQuery	createMessageQuery()
ReactionQuery	createReactionQuery()
void	deleteMessage(String messageId, String userId)
Message	findById(String messageId)
void	markMessageAsRead(String messageId, String userId)
String	reactToMessage(String messageId, String userId, String reaction)
void	referenceMessage(String messageId, String referenceId, String referenceType) Reference the message with the given messageId with the referenceId and referenceType.
void	removeReactionToMessage(String reactionId)
void	updateMessageActionInstanceId(String actionInstanceId, String messageId, String userId)
Message	updateMessageCategory(String messageId, String category)
Message	updateMessageContent(String messageId, String mainContent)

Method Detail

createMessageBuilder

MessageBuilder createMessageBuilder()

createMessageQuery

MessageQuery createMessageQuery()

findById

Message findById(String messageId)

markMessageAsRead

void markMessageAsRead(String messageId,
                       String userId)

updateMessageActionInstanceId

void updateMessageActionInstanceId(String actionInstanceId,
                                   String messageId,
                                   String userId)

deleteMessage

void deleteMessage(String messageId,
                   String userId)

referenceMessage

void referenceMessage(String messageId,
                      String referenceId,
                      String referenceType)

Reference the message with the given messageId with the referenceId and referenceType. It is not possible to reference an already referenced message.

Parameters:

messageId - the id of the message that needs to be referenced

referenceId - the id of the reference

referenceType - the type of the reference

updateMessageContent

Message updateMessageContent(String messageId,
                             String mainContent)

updateMessageCategory

Message updateMessageCategory(String messageId,
                              String category)

createReactionQuery

ReactionQuery createReactionQuery()

reactToMessage

String reactToMessage(String messageId,
                      String userId,
                      String reaction)

removeReactionToMessage

void removeReactionToMessage(String reactionId)