Package com.flowable.engage.external.system.wechat

Class WeChatTemplateMessageBot

java.lang.Object

com.flowable.engage.external.system.wechat.WeChatTemplateMessageBot

All Implemented Interfaces:

BotService

public class WeChatTemplateMessageBot
extends Object
implements BotService

An action bot handling the action definition to send a WeChat template message based on a template handled by the template engine.

Author:

Micha Kiener

Field Summary

Fields

Modifier and Type	Field	Description
protected final ConversationPermissionService	conversationPermissionService
protected final ConversationService	conversationService
protected final JmsMessageOperations	jmsMessagingOperations
protected final MessageService	messageService
protected final PlatformIdentityService	platformIdentityService
protected final TemplateService	templateService
protected final UserAccountService	userAccountService
static final String	WECHAT_TEMPLATE_ACTION_DEFINITION_KEY
static final String	WECHAT_TEMPLATE_KEY
protected final WeChatProperties	weChatProperties

Constructor Summary

Constructors

Constructor	Description
WeChatTemplateMessageBot(TemplateService templateService, ConversationService conversationService, ConversationPermissionService conversationPermissionService, MessageService messageService, PlatformIdentityService platformIdentityService, JmsMessageOperations jmsMessageOperations, WeChatProperties weChatProperties, UserAccountService userAccountService)

Method Summary

Modifier and Type	Method	Description
protected void	checkTemplateParametersSize(Map<String,String> templateParameters)	Check if the total size of all the template parameters do not exceed the maximum allowed size which is given by WeChat.
protected Map<String,String>	extractTemplateParameters(List<TemplateParameter> templateParameters, Map<String,Object> payload)	Extract all the template parameters from the payload.
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.
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.
protected void	sendExternalTemplateMessage(Conversation conversation, Message internalMessage, Map<String,String> templateParameters, String weChatTemplateId)

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

WECHAT_TEMPLATE_KEY

public static final String WECHAT_TEMPLATE_KEY

See Also:

• Constant Field Values

WECHAT_TEMPLATE_ACTION_DEFINITION_KEY

public static final String WECHAT_TEMPLATE_ACTION_DEFINITION_KEY

See Also:

• Constant Field Values

templateService

protected final TemplateService templateService

conversationService

protected final ConversationService conversationService

conversationPermissionService

protected final ConversationPermissionService conversationPermissionService

messageService

protected final MessageService messageService

platformIdentityService

protected final PlatformIdentityService platformIdentityService

jmsMessagingOperations

protected final JmsMessageOperations jmsMessagingOperations

weChatProperties

protected final WeChatProperties weChatProperties

userAccountService

protected final UserAccountService userAccountService

Constructor Details

WeChatTemplateMessageBot

public WeChatTemplateMessageBot(TemplateService templateService,
 ConversationService conversationService,
 ConversationPermissionService conversationPermissionService,
 MessageService messageService,
 PlatformIdentityService platformIdentityService,
 JmsMessageOperations jmsMessageOperations,
 WeChatProperties weChatProperties,
 UserAccountService userAccountService)

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

sendExternalTemplateMessage

protected void sendExternalTemplateMessage(Conversation conversation,
 Message internalMessage,
 Map<String,String> templateParameters,
 String weChatTemplateId)

extractTemplateParameters

protected Map<String,String> extractTemplateParameters(List<TemplateParameter> templateParameters,
 Map<String,Object> payload)

Extract all the template parameters from the payload.

Parameters:

templateParameters -

payload -

Returns:

a map of the extracted parameters

checkTemplateParametersSize

protected void checkTemplateParametersSize(Map<String,String> templateParameters)

Check if the total size of all the template parameters do not exceed the maximum allowed size which is given by WeChat.

Parameters:

templateParameters -