Package com.flowable.engage.engine.impl.desk.bot

Class DeskManagementBot

java.lang.Object

com.flowable.engage.engine.impl.desk.bot.DeskManagementBot

All Implemented Interfaces:

BotService

public class DeskManagementBot
extends Object
implements BotService

A service bot managing desk and ticket conversations.

Author:

Micha Kiener

Field Summary

Fields

Modifier and Type	Field	Description
protected final ConversationPermissionService	conversationPermissionService
protected final ConversationService	conversationService
protected final DeskService	deskService
protected final PlatformIdentityService	identityService
protected final MessageService	messageService
protected final UserDefinitionService	userDefinitionService

Constructor Summary

Constructors

Constructor	Description
DeskManagementBot(ConversationService conversationService, ConversationPermissionService conversationPermissionService, MessageService messageService, PlatformIdentityService identityService, UserDefinitionService userDefinitionService, DeskService deskService)

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns the optional description of this bot, describing its capabilities or prerequisites.
String	getKey()	Returns the key of this bot which is used to link ActionDefinitions to this bot.
String	getName()	Returns the name of this bot, typically used as the label for it.
protected void	handleAssignTicketAction(String conversationId, String currentUserId, Map<String,Object> payload)
protected void	handleCreateNewTicketAction(String conversationId, String currentUserId, Map<String,Object> payload)
protected void	handleRemoveDeskMemberFromTicketAction(String conversationId, String currentUserId, Map<String,Object> payload)
BotActionResult	invokeBot(HistoricActionInstance actionInstance, ActionDefinition actionDefinition, Map<String,Object> payload)	Whenever an action definition is triggered, an action instance is created and this method is invoked in order to execute the action.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.flowable.action.api.bot.BotService

invokeBot

Field Details

conversationService

protected final ConversationService conversationService

conversationPermissionService

protected final ConversationPermissionService conversationPermissionService

messageService

protected final MessageService messageService

identityService

protected final PlatformIdentityService identityService

userDefinitionService

protected final UserDefinitionService userDefinitionService

deskService

protected final DeskService deskService

Constructor Details

DeskManagementBot

public DeskManagementBot(ConversationService conversationService,
 ConversationPermissionService conversationPermissionService,
 MessageService messageService,
 PlatformIdentityService identityService,
 UserDefinitionService userDefinitionService,
 DeskService deskService)

Method Details

getKey

public String getKey()

Description copied from interface: BotService

Returns the key of this bot which is used to link ActionDefinitions to this bot.

Specified by:

getKey in interface BotService

Returns:

the key of this bot, which needs to be unique amongst other bots

getName

public String getName()

Description copied from interface: BotService

Returns the name of this bot, typically used as the label for it.

Specified by:

getName in interface BotService

Returns:

the name of this bot

getDescription

public String getDescription()

Description copied from interface: BotService

Returns the optional description of this bot, describing its capabilities or prerequisites.

Specified by:

getDescription in interface BotService

Returns:

the optional description of this bot

invokeBot

public BotActionResult invokeBot(HistoricActionInstance actionInstance,
 ActionDefinition actionDefinition,
 Map<String,Object> payload)

Description copied from interface: BotService

Whenever an action definition is triggered, an action instance is created and this method is invoked in order to execute the action. You need to provide an action result according the execution and follow up needed.

API NOTE: Prefer overriding BotService.invokeBot(BotInvocationContext) instead and leave this empty. Alternatively use ContextAwareBotService instead, to avoid overriding an empty method.

Specified by:

invokeBot in interface BotService

Parameters:

actionInstance - the action instance to run

actionDefinition - the action definition where the action instance is based on

payload - the optional payload containing the necessary information to run the action

handleCreateNewTicketAction

protected void handleCreateNewTicketAction(String conversationId,
 String currentUserId,
 Map<String,Object> payload)

handleAssignTicketAction

protected void handleAssignTicketAction(String conversationId,
 String currentUserId,
 Map<String,Object> payload)

handleRemoveDeskMemberFromTicketAction

protected void handleRemoveDeskMemberFromTicketAction(String conversationId,
 String currentUserId,
 Map<String,Object> payload)