com.flowable.engage.engine.impl.bot

Class ConversationManagementBot

java.lang.Object

com.flowable.engage.engine.impl.bot.ConversationManagementBot

All Implemented Interfaces:

com.flowable.action.api.bot.BotService

public class ConversationManagementBot
extends Object
implements com.flowable.action.api.bot.BotService

A service bot supporting basic conversation management functionality like joining or dropping participants, archiving, etc.

Author:

Micha Kiener

Field Summary

Fields

Modifier and Type	Field and Description
protected ConversationPermissionService	conversationPermissionService
protected ConversationService	conversationService
protected String	digitalAssistantUserId The user id of the digital assistant used in ticket and desk conversations, defaults to the digital assistant user, if not changed.
protected com.flowable.core.idm.api.PlatformIdentityService	identityService
protected MessageService	messageService

Constructor Summary

Constructors

Constructor and Description
ConversationManagementBot(ConversationService conversationService, MessageService messageService, ConversationPermissionService conversationPermissionService, com.flowable.core.idm.api.PlatformIdentityService identityService)

Method Summary

Modifier and Type	Method and Description
protected com.flowable.action.api.bot.BotActionResult	addParticipantsToConversation(Collection<String> participantIds, String conversationId, String authenticatedUserId)
protected com.flowable.action.api.bot.BotActionResult	archiveConversation(String conversationId, String authenticatedUserId)
String	getDescription()
String	getDigitalAssistantUserId()
String	getKey()
String	getName()
protected String	getStringValueOrNull(Object value)
String	getUserName(String userId)
protected com.flowable.action.api.bot.BotActionResult	handleCreateNewTopicAction(String conversationId, String currentUserId, Map<String,Object> payload, String userIdForPermissionChecks)
com.flowable.action.api.bot.BotActionResult	invokeBot(com.flowable.action.api.history.HistoricActionInstance actionInstance, com.flowable.action.api.repository.ActionDefinition actionDefinition, Map<String,Object> payload)
protected com.flowable.action.api.bot.BotActionResult	removeParticipantsFromConversation(Collection<String> participantIds, String conversationId, String authenticatedUserId)
void	setDigitalAssistantUserId(String digitalAssistantUserId)
protected void	validateAddParticipantsPermission(Collection<String> participantIds, String conversationId, String authenticatedUserId)
protected void	validateArchiveConversationPermission(String conversationId, String authenticatedUserId)
protected void	validateDropParticipantsPermission(Collection<String> participantIds, String conversationId, String authenticatedUserId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

digitalAssistantUserId

protected String digitalAssistantUserId

The user id of the digital assistant used in ticket and desk conversations, defaults to the digital assistant user, if not changed.

conversationService

protected final ConversationService conversationService

messageService

protected final MessageService messageService

conversationPermissionService

protected final ConversationPermissionService conversationPermissionService

identityService

protected final com.flowable.core.idm.api.PlatformIdentityService identityService

Constructor Detail

ConversationManagementBot

public ConversationManagementBot(ConversationService conversationService,
                                 MessageService messageService,
                                 ConversationPermissionService conversationPermissionService,
                                 com.flowable.core.idm.api.PlatformIdentityService identityService)

Method Detail

getKey

public String getKey()

Specified by:

getKey in interface com.flowable.action.api.bot.BotService

getName

public String getName()

Specified by:

getName in interface com.flowable.action.api.bot.BotService

getDescription

public String getDescription()

Specified by:

getDescription in interface com.flowable.action.api.bot.BotService

invokeBot

public com.flowable.action.api.bot.BotActionResult invokeBot(com.flowable.action.api.history.HistoricActionInstance actionInstance,
                                                             com.flowable.action.api.repository.ActionDefinition actionDefinition,
                                                             Map<String,Object> payload)

Specified by:

invokeBot in interface com.flowable.action.api.bot.BotService

addParticipantsToConversation

protected com.flowable.action.api.bot.BotActionResult addParticipantsToConversation(Collection<String> participantIds,
                                                                                    String conversationId,
                                                                                    String authenticatedUserId)

validateAddParticipantsPermission

protected void validateAddParticipantsPermission(Collection<String> participantIds,
                                                 String conversationId,
                                                 String authenticatedUserId)

removeParticipantsFromConversation

protected com.flowable.action.api.bot.BotActionResult removeParticipantsFromConversation(Collection<String> participantIds,
                                                                                         String conversationId,
                                                                                         String authenticatedUserId)

validateDropParticipantsPermission

protected void validateDropParticipantsPermission(Collection<String> participantIds,
                                                  String conversationId,
                                                  String authenticatedUserId)

archiveConversation

protected com.flowable.action.api.bot.BotActionResult archiveConversation(String conversationId,
                                                                          String authenticatedUserId)

validateArchiveConversationPermission

protected void validateArchiveConversationPermission(String conversationId,
                                                     String authenticatedUserId)

handleCreateNewTopicAction

protected com.flowable.action.api.bot.BotActionResult handleCreateNewTopicAction(String conversationId,
                                                                                 String currentUserId,
                                                                                 Map<String,Object> payload,
                                                                                 String userIdForPermissionChecks)

getStringValueOrNull

protected String getStringValueOrNull(Object value)

getUserName

public String getUserName(String userId)

getDigitalAssistantUserId

public String getDigitalAssistantUserId()

setDigitalAssistantUserId

public void setDigitalAssistantUserId(String digitalAssistantUserId)