Uses of Interface
com.flowable.engage.conversation.api.Conversation

Packages that use Conversation

Package	Description
com.flowable.engage.api.delegate.event
com.flowable.engage.conversation.api
com.flowable.engage.engine.delegate.event.impl
com.flowable.engage.engine.impl.action
com.flowable.engage.engine.impl.cmd
com.flowable.engage.engine.impl.conversation
com.flowable.engage.engine.impl.desk
com.flowable.engage.engine.impl.desk.cmd
com.flowable.engage.engine.impl.indexing
com.flowable.engage.engine.impl.message
com.flowable.engage.engine.impl.notification
com.flowable.engage.engine.impl.permission.cmd
com.flowable.engage.engine.impl.persistence.entity
com.flowable.engage.engine.impl.persistence.entity.data
com.flowable.engage.engine.impl.persistence.entity.data.impl
com.flowable.engage.engine.impl.util
com.flowable.engage.external.system.wechat
com.flowable.engage.external.system.whatsapp

Uses of Conversation in com.flowable.engage.api.delegate.event

Methods in com.flowable.engage.api.delegate.event that return Conversation

Modifier and Type	Method and Description
Conversation	FlowableSendNotificationEvent.getConversation()
Conversation	FlowableRemovedParticipantsEvent.getConversation() The conversation with the removed participants.
Conversation	FlowableMessageEvent.getConversation()
Conversation	FlowableConversationStartedEvent.getConversation()
Conversation	FlowableConversationReferenceUpdatedEvent.getConversation()
Conversation	FlowableConversationNameUpdatedEvent.getConversation()
Conversation	FlowableConversationDeletedEvent.getConversation()
Conversation	FlowableConversationArchivedEvent.getConversation()
Conversation	FlowableAddedParticipantsEvent.getConversation() The conversation with the updated participants.

Uses of Conversation in com.flowable.engage.conversation.api

Methods in com.flowable.engage.conversation.api that return Conversation

Modifier and Type	Method and Description
Conversation	ConversationService.findById(String conversationId) Finds the conversation with the given id.
Conversation	ConversationService.findByIdWithIdentityLinks(String conversationId) Finds the conversation with the given id, with the identity links already prefetched.
Conversation	ConversationService.findByIdWithIdentityLinksAndVariables(String conversationId) Finds the conversation with the given id, with the identity links and variables already prefetched.
Conversation	ConversationHolder.getConversation() Returns the underlying conversation this holder is built with.
Conversation	ConversationService.setReference(String conversationId, String referenceId, String referenceType, String referenceDefinitionId) Set the optional reference for a conversation like a case or process where the conversation is liked to.
Conversation	ConversationBuilder.start() Returns the newly created conversation object.
Conversation	ConversationBuilder.startWithPermissionCheck(String userId) Deprecated. use ConversationBuilder.startWithPermissionCheck(String, Collection, String) instead
Conversation	ConversationBuilder.startWithPermissionCheck(String userId, Collection<String> userGroupKeys, String userTenantId) Same as ConversationBuilder.start() with an additional permission check that the user with userId is allowed to create the conversation.
Conversation	ConversationService.updateAvatarId(String conversationId, String avatarId) Updates the conversation avatar id for the given conversation.
Conversation	ConversationService.updateDescription(String conversationId, String description) Updates the conversation description for the given conversation.
Conversation	ConversationService.updateName(String conversationId, String name) Updates the conversation name (title) for the given conversation.

Methods in com.flowable.engage.conversation.api that return types with arguments of type Conversation

Modifier and Type	Method and Description
List<Conversation>	ConversationService.findConversationsWithLastMessageBetween(Date from, Date until, boolean includePrivateMessages, boolean includeStickMessages) TODO: this might be not the right service Finds conversations which received new messages within a given time frame.

Methods in com.flowable.engage.conversation.api with parameters of type Conversation

Modifier and Type	Method and Description
void	ConversationNotificationService.sendNotification(Message message, Conversation conversation) Send a notification for the given message in the given conversation

Uses of Conversation in com.flowable.engage.engine.delegate.event.impl

Fields in com.flowable.engage.engine.delegate.event.impl declared as Conversation

Modifier and Type	Field and Description
protected Conversation	FlowableSendNotificationEventImpl.conversation
protected Conversation	FlowableRemovedParticipantsEventImpl.conversation
protected Conversation	FlowableMessageEventImpl.conversation
protected Conversation	FlowableConversationStartedEventImpl.conversation
protected Conversation	FlowableConversationReferenceUpdatedEventImpl.conversation
protected Conversation	FlowableConversationNameUpdatedEventImpl.conversation
protected Conversation	FlowableConversationDeletedEventImpl.conversation
protected Conversation	FlowableConversationArchivedEventImpl.conversation
protected Conversation	FlowableAddedParticipantsEventImpl.conversation

Methods in com.flowable.engage.engine.delegate.event.impl that return Conversation

Modifier and Type	Method and Description
Conversation	FlowableSendNotificationEventImpl.getConversation()
Conversation	FlowableRemovedParticipantsEventImpl.getConversation()
Conversation	FlowableMessageEventImpl.getConversation()
Conversation	FlowableConversationStartedEventImpl.getConversation()
Conversation	FlowableConversationReferenceUpdatedEventImpl.getConversation()
Conversation	FlowableConversationNameUpdatedEventImpl.getConversation()
Conversation	FlowableConversationDeletedEventImpl.getConversation()
Conversation	FlowableConversationArchivedEventImpl.getConversation()
Conversation	FlowableAddedParticipantsEventImpl.getConversation()

Methods in com.flowable.engage.engine.delegate.event.impl with parameters of type Conversation

Modifier and Type	Method and Description
static FlowableAddedParticipantsEvent	FlowableEngageEventBuilder.createAddedParticipantsEvent(Conversation conversation, Collection<String> addedParticipants, String userId)
static FlowableMessageEvent	FlowableEngageEventBuilder.createBeforeMessagePersistedEvent(Message message, Conversation conversation)
static FlowableConversationArchivedEvent	FlowableEngageEventBuilder.createConversationArchivedEvent(Conversation conversation)
static FlowableConversationDeletedEvent	FlowableEngageEventBuilder.createConversationDeletedEvent(Conversation conversation)
static FlowableConversationNameUpdatedEvent	FlowableEngageEventBuilder.createConversationNameUpdatedEvent(Conversation conversation, String oldName)
static FlowableConversationReferenceUpdatedEvent	FlowableEngageEventBuilder.createConversationReferenceUpdatedEvent(Conversation conversation, String oldReferenceId, String oldReferenceType, String oldReferenceDefinitionId)
static FlowableConversationStartedEvent	FlowableEngageEventBuilder.createConversationStartedEvent(Conversation conversation)
static FlowableMessageEvent	FlowableEngageEventBuilder.createMessageSendEvent(Message message, Conversation conversation)
static FlowableRemovedParticipantsEvent	FlowableEngageEventBuilder.createRemovedParticipantsEvent(Conversation conversation, Collection<String> removedParticipants, String userId)
static FlowableSendNotificationEvent	FlowableEngageEventBuilder.createSendNotificationEvent(Conversation conversation, Message message, Collection<NotificationInfo> notificationInfo)

Constructors in com.flowable.engage.engine.delegate.event.impl with parameters of type Conversation

Constructor and Description
FlowableAddedParticipantsEventImpl(Conversation conversation, Collection<String> addedParticipants, String userId)
FlowableConversationArchivedEventImpl(Conversation conversation)
FlowableConversationDeletedEventImpl(Conversation conversation)
FlowableConversationNameUpdatedEventImpl(Conversation conversation, String oldName)
FlowableConversationReferenceUpdatedEventImpl(Conversation conversation, String oldReferenceId, String oldReferenceType, String oldReferenceDefinitionId)
FlowableConversationStartedEventImpl(Conversation conversation)
FlowableMessageEventImpl(FlowableEngageEventType type, Message message, Conversation conversation)
FlowableRemovedParticipantsEventImpl(Conversation conversation, Collection<String> removedParticipants, String userId)
FlowableSendNotificationEventImpl(Conversation conversation, Message message, Collection<NotificationInfo> notificationInfo)

Uses of Conversation in com.flowable.engage.engine.impl.action

Methods in com.flowable.engage.engine.impl.action that return Conversation

Modifier and Type	Method and Description
Conversation	ConversationScopedObjectProvider.getScopedObject(String scopeType, String scopeId, com.flowable.core.common.api.security.SecurityScope securityScope)

Methods in com.flowable.engage.engine.impl.action with parameters of type Conversation

Modifier and Type	Method and Description
protected String	ConversationActionFilter.getScopedObjectState(Conversation conversation)
protected String	ConversationActionFilter.getScopedObjectSubState(Conversation conversation)
protected String	ConversationActionFilter.getScopedObjectSubType(Conversation conversation)
protected String	ConversationActionFilter.getScopedObjectType(Conversation conversation)

Uses of Conversation in com.flowable.engage.engine.impl.cmd

Fields in com.flowable.engage.engine.impl.cmd declared as Conversation

Modifier and Type	Field and Description
protected Conversation	SendConversationNotificationCmd.conversation

Methods in com.flowable.engage.engine.impl.cmd that return Conversation

Modifier and Type	Method and Description
Conversation	FindConversationByIdWithIdentityLinksCmd.execute(org.flowable.common.engine.impl.interceptor.CommandContext commandContext)
Conversation	FindConversationByIdWithIdentityLinksAndVariablesCmd.execute(org.flowable.common.engine.impl.interceptor.CommandContext commandContext)
Conversation	FindConversationByIdCmd.execute(org.flowable.common.engine.impl.interceptor.CommandContext commandContext)
protected Conversation	StartConversationCmd.findReUsableConversation(org.flowable.common.engine.impl.interceptor.CommandContext commandContext)
protected Conversation	StartConversationCmd.getParentConversation(ConversationBuilder builder)

Methods in com.flowable.engage.engine.impl.cmd that return types with arguments of type Conversation

Modifier and Type	Method and Description
List<Conversation>	FindConversationsWithLastMessageBetweenCmd.execute(org.flowable.common.engine.impl.interceptor.CommandContext commandContext)

Methods in com.flowable.engage.engine.impl.cmd with parameters of type Conversation

Modifier and Type	Method and Description
protected MessageEntity	BaseSendMessageCmd.createMessage(org.flowable.common.engine.impl.interceptor.CommandContext commandContext, MessageBuilderImpl messageBuilder, Conversation conversation)
protected String	BaseSendMessageCmd.getOrRenderMainContent(org.flowable.common.engine.impl.interceptor.CommandContext commandContext, Conversation conversation, MessageBuilderImpl messageBuilder)
protected List<Participant>	SendConversationNotificationCmd.getParticipants(org.flowable.common.engine.impl.interceptor.CommandContext commandContext, Conversation permissions)

Constructors in com.flowable.engage.engine.impl.cmd with parameters of type Conversation

Constructor and Description
SendConversationNotificationCmd(Message message, Conversation conversation)

Uses of Conversation in com.flowable.engage.engine.impl.conversation

Fields in com.flowable.engage.engine.impl.conversation declared as Conversation

Modifier and Type	Field and Description
protected Conversation	ConversationNotificationRunnable.conversation
protected Conversation	ConversationHolderImpl.conversation

Methods in com.flowable.engage.engine.impl.conversation that return Conversation

Modifier and Type	Method and Description
Conversation	ConversationServiceImpl.findById(String conversationId)
Conversation	ConversationServiceImpl.findByIdWithIdentityLinks(String conversationId)
Conversation	ConversationServiceImpl.findByIdWithIdentityLinksAndVariables(String conversationId)
Conversation	ConversationHolderImpl.getConversation()
Conversation	ConversationServiceImpl.setReference(String conversationId, String referenceId, String referenceType, String referenceDefinitionId)
Conversation	ConversationBuilderImpl.start()
Conversation	ConversationServiceImpl.startConversation(ConversationBuilderImpl conversationBuilder)
Conversation	ConversationBuilderImpl.startWithPermissionCheck(String userId) Deprecated.
Conversation	ConversationBuilderImpl.startWithPermissionCheck(String userId, Collection<String> userGroupKeys, String userTenantId)
Conversation	ConversationServiceImpl.updateAvatarId(String conversationId, String avatarId)
Conversation	ConversationServiceImpl.updateDescription(String conversationId, String description)
Conversation	ConversationServiceImpl.updateName(String conversationId, String name)

Methods in com.flowable.engage.engine.impl.conversation that return types with arguments of type Conversation

Modifier and Type	Method and Description
List<Conversation>	ConversationQueryImpl.executeList(org.flowable.common.engine.impl.interceptor.CommandContext commandContext)
List<Conversation>	ConversationServiceImpl.findConversationsWithLastMessageBetween(Date from, Date until, boolean includePrivateMessages, boolean includeStickMessages)

Methods in com.flowable.engage.engine.impl.conversation with parameters of type Conversation

Modifier and Type	Method and Description
static ConversationHolderImpl	ConversationHolderImpl.forNewConversation(Conversation conversation)
static ConversationHolderImpl	ConversationHolderImpl.forReusedConversation(Conversation conversation)
void	ConversationNotificationServiceImpl.sendNotification(Message message, Conversation conversation)

Constructors in com.flowable.engage.engine.impl.conversation with parameters of type Conversation

Constructor and Description
ConversationHolderImpl(Conversation conversation, boolean newConversation)
ConversationNotificationRunnable(EngageEngineConfiguration configuration, Message message, Conversation conversation)

Uses of Conversation in com.flowable.engage.engine.impl.desk

Methods in com.flowable.engage.engine.impl.desk that return Conversation

Modifier and Type	Method and Description
Conversation	DeskServiceImpl.startTicketConversation(String deskConversationId, Collection<String> participantIds, String name, Map<String,Object> variables, String userIdForPermissionChecks)
Conversation	DeskService.startTicketConversation(String deskConversationId, Collection<String> participantIds, String name, Map<String,Object> variables, String userIdForPermissionChecks) Starts a new ticket conversation as part of a desk.

Uses of Conversation in com.flowable.engage.engine.impl.desk.cmd

Methods in com.flowable.engage.engine.impl.desk.cmd that return Conversation

Modifier and Type	Method and Description
Conversation	StartTicketConversationCmd.execute(org.flowable.common.engine.impl.interceptor.CommandContext commandContext)
Conversation	AbstractTicketCmd.getDeskConversation(org.flowable.common.engine.impl.interceptor.CommandContext commandContext)
Conversation	AbstractTicketCmd.getTicketConversation(org.flowable.common.engine.impl.interceptor.CommandContext commandContext)

Uses of Conversation in com.flowable.engage.engine.impl.indexing

Fields in com.flowable.engage.engine.impl.indexing declared as Conversation

Modifier and Type	Field and Description
protected Conversation	ConversationFilterQueryImpl.applicableConversation

Methods in com.flowable.engage.engine.impl.indexing that return Conversation

Modifier and Type	Method and Description
Conversation	ConversationFilterQueryImpl.getApplicableConversation()

Methods in com.flowable.engage.engine.impl.indexing with parameters of type Conversation

Modifier and Type	Method and Description
protected void	ConversationIndexingEventListener.indexConversation(Conversation conversation)
ConversationFilterQuery	ConversationFilterQueryImpl.matches(Conversation conversation)
ConversationFilterQuery	ConversationFilterQuery.matches(Conversation conversation) Query conversation filters matching the given conversation
boolean	ConversationFilterImpl.matches(Conversation conversation)
boolean	ConversationFilter.matches(Conversation conversation)

Uses of Conversation in com.flowable.engage.engine.impl.message

Methods in com.flowable.engage.engine.impl.message with parameters of type Conversation

Modifier and Type	Method and Description
String	MessageSendHelper.renderMainContent(Conversation conversation, String receivingUserId, String messageKey, String messageCode, String messageLanguage, Map<String,Object> messagePayload) Render the content of the template
String	DefaultMessageSendHelper.renderMainContent(Conversation conversation, String receivingUserId, String messageKey, String messageCode, String messageLanguage, Map<String,Object> messagePayload)
boolean	MessageSendHelper.shouldHandleAsTemporaryMessage(Message message, Conversation conversation) Check whether the message should be handled as a temporary message.
boolean	DefaultMessageSendHelper.shouldHandleAsTemporaryMessage(Message message, Conversation conversation)

Uses of Conversation in com.flowable.engage.engine.impl.notification

Methods in com.flowable.engage.engine.impl.notification with parameters of type Conversation

Modifier and Type	Method and Description
Collection<NotificationInfo>	NotificationEvaluationProviderImpl.evaluateNotifications(Message data, Conversation conversation, Collection<Participant> participants)
Collection<NotificationInfo>	NotificationEvaluationProvider.evaluateNotifications(Message data, Conversation conversation, Collection<Participant> participants) Evaluates the notifications and message data read behavior for all participants according a rules set and the participants profile (e.g.

Uses of Conversation in com.flowable.engage.engine.impl.permission.cmd

Methods in com.flowable.engage.engine.impl.permission.cmd with parameters of type Conversation

Modifier and Type	Method and Description
protected Optional<String>	AbstractConversationPermissionCommand.checkBasicConversationAccess(org.flowable.common.engine.impl.interceptor.CommandContext commandContext, String userId, Conversation conversation, com.flowable.platform.service.permission.ParticipantType participantType) Basic conversation access check if the participant type has already been resolved.
protected Map<String,Object>	AbstractConversationPermissionCommand.createRuleInputForDefaultModel(String userId, com.flowable.platform.service.permission.AuthorizedAction action, Conversation scopedObject, Map<String,Object> detailedRuleInput, org.flowable.common.engine.impl.interceptor.CommandContext commandContext)
protected Optional<String>	AbstractConversationPermissionCommand.evaluatePermissionsAndProcessResult(String tenantId, com.flowable.platform.service.permission.AuthorizedAction action, Conversation scopedObject, Map<String,Object> ruleInput, String decisionModelKey, String globalErrorMessageCode, org.flowable.common.engine.impl.interceptor.CommandContext commandContext)
protected String	CheckCreateConversationCommand.getTenantId(Conversation conversation)
protected String	AbstractConversationPermissionCommand.getTenantId(Conversation conversation)

Uses of Conversation in com.flowable.engage.engine.impl.persistence.entity

Subinterfaces of Conversation in com.flowable.engage.engine.impl.persistence.entity

Modifier and Type	Interface and Description
interface	ConversationEntity

Classes in com.flowable.engage.engine.impl.persistence.entity that implement Conversation

Modifier and Type	Class and Description
class	ConversationEntityImpl

Methods in com.flowable.engage.engine.impl.persistence.entity that return types with arguments of type Conversation

Modifier and Type	Method and Description
List<Conversation>	ConversationEntityManagerImpl.findByCriteria(ConversationQuery query)
List<Conversation>	ConversationEntityManager.findByCriteria(ConversationQuery query)
List<Conversation>	ConversationEntityManagerImpl.findConversationsWithLastMessageBetween(Date from, Date until, boolean includePrivate, boolean includeSticky)
List<Conversation>	ConversationEntityManager.findConversationsWithLastMessageBetween(Date from, Date until, boolean includePrivate, boolean includeSticky)

Uses of Conversation in com.flowable.engage.engine.impl.persistence.entity.data

Methods in com.flowable.engage.engine.impl.persistence.entity.data that return types with arguments of type Conversation

Modifier and Type	Method and Description
List<Conversation>	ConversationDataManager.findByCriteria(ConversationQueryImpl query)
List<Conversation>	ConversationDataManager.findConversationsWithLastMessageBetween(Date from, Date until, boolean includePrivate, boolean includeSticky)

Uses of Conversation in com.flowable.engage.engine.impl.persistence.entity.data.impl

Methods in com.flowable.engage.engine.impl.persistence.entity.data.impl that return types with arguments of type Conversation

Modifier and Type	Method and Description
List<Conversation>	MybatisConversationDataManager.findByCriteria(ConversationQueryImpl query)
List<Conversation>	MybatisConversationDataManager.findConversationsWithLastMessageBetween(Date from, Date until, boolean includePrivate, boolean includeSticky)

Uses of Conversation in com.flowable.engage.engine.impl.util

Methods in com.flowable.engage.engine.impl.util with parameters of type Conversation

Modifier and Type	Method and Description
static MessageEntity	MessageUtil.handleMessageInsert(MessageEntity message, Conversation conversation, org.flowable.common.engine.impl.interceptor.CommandContext commandContext)

Uses of Conversation in com.flowable.engage.external.system.wechat

Methods in com.flowable.engage.external.system.wechat with parameters of type Conversation

Modifier and Type	Method and Description
protected void	WeChatSenderMessageListener.triggerProcessOrPostponeTimeout(Conversation conversation, com.flowable.core.idm.api.PlatformUser user, com.flowable.core.idm.api.UserAccount userAccount)

Uses of Conversation in com.flowable.engage.external.system.whatsapp

Methods in com.flowable.engage.external.system.whatsapp with parameters of type Conversation

Modifier and Type	Method and Description
protected void	WhatsAppSenderMessageListener.triggerProcessOrPostponeTimeout(Conversation conversation, com.flowable.core.idm.api.PlatformUser user, com.flowable.core.idm.api.UserAccount userAccount)