All Classes and Interfaces
Class
Description
An abstract base implementation for a tag evaluation context.
An abstract base class for desk and ticket related commands.
Abstract base class for implementations of
AutoDeploymentStrategy.An abstract tag provider supporting some common functionality for conversation tag providers.
An abstract base class for ticket based commands.
Assigns a conversation to a group.
Assigns a conversation to a user.
This enumeration contains a list of actions which are authorized as part of the permission check when executing
actions in a conversation.
Base class that can be used by different external system provider
to provide an implementation for the sending of the outbound message.
Abstract base implementation for updating different aspects of a conversation.
The enumeration of message categories.
Changes the owner of the conversation.
Checks the permission to edit a message within a conversation using a DMN permission table.
This default implementation simply returns a configured, fixed tenant id regardless of the content of the inbound message.
An interface with constants about the supported content types used in
Message.getMainContentType().The conversation is a container where messaging and events between humans and even bots happen.
A builder interface building
Conversation objects.A tag evaluation context based on a conversation builder in order to be able to modify the tags through it.
Annotation that can be used to trigger a deployment of conversation definitions for the provided test.
Builder for bulk registration of Conversation Definitions.
A tag evaluation context based on an existing conversation represented by its conversation entity so it can be
modified.
A user has a list of filters that can be applied when retrieving conversations.
Exposes methods to retrieve conversation filters and use those filters to find conversations.
The conversation holder might be used to hold a conversation and additional information like if it was a newly
created one or an existing one.
A service bot supporting basic conversation management functionality like joining or dropping participants, archiving, etc.
An events listener that is responsible for sending messages to a conversation when an event occurs.
Notification service for the Conversations which is responsible for sending messages to conversation.
This builder supports various ways to add or drop participants within a conversation with smart options like letting them see previous messages or even
all past messages and similar options.
Default implementation for the participant builder API.
The permission helper must be used to check permissions on actions to be executed in the context of a conversation
like adding or removing participants or posting a voice message, etc.
The default implementation of the permission helper checking permissions for certain conversation related actions
with the help of a two-step DMN decision model approach.
Allows for programmatic querying of conversations.
An entry of a conversation participant registry.
Allows for programmatic querying of conversation registry entries.
The implementation of the
ConversationRegistryEntryQuery interface used to query for conversation registry entries.The interface you can implement when you want to enhance conversation based search hit data.
The conversation service is the main API for the conversation and messaging functionality.
The default conversation service implementation using commands to provide the necessary functionality.
This interface supports strategy methods around the starting and initialization of a conversation like initializing
data like types of a new conversation as well as searching for reusable, existing conversations when trying to start
a new one.
Interface containing the known states of a conversation.
This represents the information for the last read message for a certain user in a certain conversation
The tag evaluation context might be used within a
ConversationTagProvider to request additional information
in order to evaluate tags for conversations.A conversation tag provider is invoked during the initialization of a new
Conversation as well as if relevant
data of a conversation is changed later on, which includes:
Conversation.getType()
Conversation.getSubType()
Conversation.getOwnerId()
Conversation.getAssigneeId()
Permissions.getAssignedGroupId()
Conversation.getCandidateUserIds()
Conversation.getCandidateGroupIds()
There might be a chain of tag providers each one of it providing tags to be added to the list of tags of the
conversation.The conversation type specifies the conversation in more detail.
A participant query object can be obtained through
ConversationService.createConversationUserQuery() and can be used to query for participant
information within a conversation.The implementation of the
ConversationUserQuery interface used to query for users involved in a conversation.Number of conversations which received new messages within a given time frame.
A delivery context that is used for sending messages.
A listener handling message send and conversation creation events for desk and ticket conversations.
A service bot managing desk and ticket conversations.
An interface containing message codes (constants) used within desk and ticket conversations.
This utility helps creating template based messages used within desk and ticket conversations.
The desk and ticket management service interface is used to control and manage desk and ticket conversations.
The default desk and ticket service implementation.
JUnit Jupiter extension for the Flowable Platform engage engine and services initialization.
A job handler handling Engage SLA based escalation steps for tasks.
Maintains a list of all the entities in order of dependency.
Initializes the avatar url or id depending on some previously evaluated tags (e.g.
This command evaluates conversation tags by using a set of configured tag providers and updates the conversation
accordingly.
An inbound message account service creating internal system events from inbound messages not having a mapped account or an inactive account or user so any
listeners (like a case or process instance) might picking it up and processing it.
Interface that needs to be implemented by an external conversation system provider.
Holder for the publicly accessible URLs for the media sent to LINE.
Builder that can be used for sending external messages
A content provider that is responsible for fetching the actual content
from the external system.
Service that is responsible for fetching content from the external systems.
This interface contains some available external system ids.
Resolves the participants of a conversation with options whether to only include directly assigned users or
users assigned over member groups (like candidate groups or assigned group).
Finds conversations which received new messages within a given time frame.
Event fired when participants have been added to a conversation.
Event fired when tags have been added to a conversation.
Event thrown if the reference of a conversation was set or updated.
Simple implementation for the reference update event of a conversation.
Event fired when tags have been removed from a conversation.
Enumeration containing all possible types of
FlowableEngageEvents for the Engage engine.Event fired when participants have been removed from a conversation.
Handle new inbound message within an unassigned ticket.
Handler for inbound errors from an external adapter.
Service for handling inbound messages for a particular account
Builder for sending inbound messages (messages from external adapters) to the engage platform.
Message handler for inbound messages (messages from external adapters).
A routing service for inbound messages from the external adapters.
A service provider interface hooking in the business logic to extract or resolve the tenant id out of a new inbound message not yet been mapped to a user
account object.
Service responsible for providing the handlers for the different inbound handlers
for different external adapters.
Handler for inbound statuses from the external adapters
Initializes a newly created ticket conversation as a child of a desk conversation.
An in memory user subscription service.
Represents the joining type of a
Conversation which defines on how new participants can join a running
conversation.A data object holding the information about one or more participants to join a conversation at a specific time.
An internal endpoint providing special type of accessing content send from Engage to LINE.
An API that can be implemented to provide the publicly accessible URLs for the media content that needs to be sent to LINE.
The message object that holds all relevant data describing the
event, message, action, etc
The message builder API to create messages to be sent to a conversation using the
MessageBuilder.send(String) method within the builder.The interface you can implement when you want to enhance message compliance based search hit data.
A message deliver that can be used to deliver a message via some channel.
An interface holding the known
MessageDeliverer types.The default message implementation.
The interface you can implement when you want to enhance message based search hit data.
A list of supported tags for messages.
This interface might be implemented on an enumeration or instance based type to get a name from a type.
Notification flags that provide information for sending messages
A notification schema provider is calculating the set of notifications for each recipient of a data object within a
conversation depending on various input like conversation type, sub-type, tags, etc to determine whether to send
desk and / or mobile notifications and how to handle the badge count for unread messages.
Holder for the information required for sending a notification to the user.
The notification message that needs to be transmitted in real time
Provider of
NotificationMessage(s) that can be used for creating the notificationsNotification service that is responsible for distributing the real time message.
The DTO for outbound messages (messages send by the engage platform to the different external system implementations).
Holds the information for a single participant within a conversation or a recipient of a message.
A tag provider looking for participants being a member of certain groups and add tags accordingly.
Once you start joining a new participant to an existing conversation, there are a lot of options which can be set additionally using this builder API
which is returned with one of the join methods in the
ConversationParticipantBuilder API.Default implementation of the joining builder to define the exact time of when to join a set of participants.
A builder creates list of participants.
This interface must be implemented by data objects supporting permissions.
Represents the type used for handling permissions within a
Conversation.This utility helps creating template based messages used within processes.
Removes the assigned group from a conversation.
Removes the assigned user from a conversation.
A tag provider which is adding the
ReplyOnAbsentTagProvider.TAG_REPLY_ON_ABSENT tag for DM conversations with client participation.Sets or updates the referenced work item of a conversation using its id, type and optional definition id.
This interface contains some standard message codes to be used for rendering template messages using
TemplateMessageUtil.Starts a new ticket conversation as part of a desk conversation.
Removes the current assignee of a ticket conversation and assigns it back to the desk team.
Switches the assignee of a ticket converrsation to a member of the desk team.
The common interface for all taggable objects like com.flowable.engage.conversation.api.Conversation
and com.flowable.engage.message.api.Message
Some utility functions around the tagging for conversations and messages.
This utility helps creating template based standard messages.
A temporary message that is a copy of
Message
that is used when some messages should be handled separately.A handler of a
TemporaryMessage after all
TemporaryMessageProcessor(s) have run.A processor of a
TemporaryMessage which is invoked
during the async handling of the messages.Result for a processing of a temporary message.
Event listener which is responsible for updating the message counts for a conversation.
Interface that handles the user real time connect and disconnect events.
The user subscription service that can be used to query and update user subscriptions.
ExternalSystemContentProvider that uses WebClient to fetch the external content.Event handler for the websocket session events.
JMS listener that is used to receive inbound get access token message.
JMS listener that is used to receive inbound messages from a WeChat adapter over JMS.
Listeners that makes sure that the process for notifying conversations
JMS listener that is used to receive inbound get access token message.
An action bot handling the action definition to send a WeChat template message based on a template handled by the template engine.
In order to understand this API better you need to be familiar with the WhatsApp
Sending Interactive Messages.
Builder for finishing building the Button message details and sending the message.
Builder for finishing building the List message details and sending the message.
Builder for building a list message section.
Builder for building a row in a section for list interactive messages.