com.flowable.engage.external.system.wechat.api

Interface WeChatTemplateMessageBuilder

All Known Implementing Classes:

WeChatTemplateMessageBuilderImpl

public interface WeChatTemplateMessageBuilder

Author:

Simon Amport

See Also:

Sending Template Messages

Method Summary

Modifier and Type	Method and Description
WeChatTemplateMessageBuilder	addTemplateTextParameter(String key, String value) Add text parameter to the body.
WeChatTemplateMessageBuilder	addTemplateTextParameters(Map<String,String> parameters) Add text parameters to the body.
WeChatTemplateMessageBuilder	businessAccountId(String businessAccountId) The id of the business account that should be used when sending out the message.
WeChatTemplateMessageBuilder	externalUserId(String externalUserId) The id of the recipient of the message.
WeChatTemplateMessageBuilder	messageId(String messageId) The id of the reference message within the Engage system.
void	send() Perform the send of the template message.
WeChatTemplateMessageBuilder	templateId(String templateId) The id of the template that is registered on the WeChat side

Method Detail

externalUserId

WeChatTemplateMessageBuilder externalUserId(String externalUserId)

The id of the recipient of the message. This is the id of the user within the WeChat system.

addTemplateTextParameters

WeChatTemplateMessageBuilder addTemplateTextParameters(Map<String,String> parameters)

Add text parameters to the body.

addTemplateTextParameter

WeChatTemplateMessageBuilder addTemplateTextParameter(String key,
                                                      String value)

Add text parameter to the body.

Parameters:

key - the key of the placeholder which is used within the template message

value - the value of the placeholder

templateId

WeChatTemplateMessageBuilder templateId(String templateId)

The id of the template that is registered on the WeChat side

messageId

WeChatTemplateMessageBuilder messageId(String messageId)

The id of the reference message within the Engage system. It is used in order to correlate the WeChat message and the Engage message.

businessAccountId

WeChatTemplateMessageBuilder businessAccountId(String businessAccountId)

The id of the business account that should be used when sending out the message.

send

void send()

Perform the send of the template message.