com.flowable.engage.external.system.whatsapp

Class WhatsAppTemplateMessageBuilderImpl

java.lang.Object

com.flowable.engage.external.system.whatsapp.WhatsAppTemplateMessageBuilderImpl

All Implemented Interfaces:

WhatsAppTemplateMessageBuilder

public class WhatsAppTemplateMessageBuilderImpl
extends Object
implements WhatsAppTemplateMessageBuilder

Author:

Filip Hrisafov

Field Summary

Fields

Modifier and Type	Field and Description
protected WhatsAppOutboundTemplateMessageDto	templateMessage
protected WhatsAppJmsExternalConversationSystemAdapter	whatsAppJmsExternalConversationSystemAdapter

Constructor Summary

Constructors

Constructor and Description
WhatsAppTemplateMessageBuilderImpl(WhatsAppJmsExternalConversationSystemAdapter whatsAppJmsExternalConversationSystemAdapter)

Method Summary

Modifier and Type	Method and Description
WhatsAppTemplateMessageBuilder	addTemplateTextParameter(String parameter) Add a positional text parameter.
WhatsAppTemplateMessageBuilder	addTemplateTextParameters(Collection<String> parameters) Add positional text parameters.
WhatsAppTemplateMessageBuilder	businessAccountId(String businessAccountId) The id of the business account that should be used when sending out the message.
WhatsAppTemplateMessageBuilder	externalUserId(String externalUserId) The id of the recipient of the message.
WhatsAppTemplateMessageBuilder	language(String language) The language of the template that should be used.
WhatsAppTemplateMessageBuilder	messageId(String messageId) The id of the reference message within the Engage system.
void	send() Perform the send of the template message.
WhatsAppTemplateMessageBuilder	templateId(String templateId) The id of the template that is registered on the WhatsApp side

Methods inherited from class java.lang.Object

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

Field Detail

whatsAppJmsExternalConversationSystemAdapter

protected final WhatsAppJmsExternalConversationSystemAdapter whatsAppJmsExternalConversationSystemAdapter

templateMessage

protected final WhatsAppOutboundTemplateMessageDto templateMessage

Constructor Detail

WhatsAppTemplateMessageBuilderImpl

public WhatsAppTemplateMessageBuilderImpl(WhatsAppJmsExternalConversationSystemAdapter whatsAppJmsExternalConversationSystemAdapter)

Method Detail

templateId

public WhatsAppTemplateMessageBuilder templateId(String templateId)

Description copied from interface: WhatsAppTemplateMessageBuilder

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

Specified by:

templateId in interface WhatsAppTemplateMessageBuilder

language

public WhatsAppTemplateMessageBuilder language(String language)

Description copied from interface: WhatsAppTemplateMessageBuilder

The language of the template that should be used.

Specified by:

language in interface WhatsAppTemplateMessageBuilder

addTemplateTextParameter

public WhatsAppTemplateMessageBuilder addTemplateTextParameter(String parameter)

Description copied from interface: WhatsAppTemplateMessageBuilder

Add a positional text parameter.

Note: The parameter must be added in the correct order according to the template message.

Specified by:

addTemplateTextParameter in interface WhatsAppTemplateMessageBuilder

addTemplateTextParameters

public WhatsAppTemplateMessageBuilder addTemplateTextParameters(Collection<String> parameters)

Description copied from interface: WhatsAppTemplateMessageBuilder

Add positional text parameters.

Note: The parameters must be added in the correct order according to the template message.

Specified by:

addTemplateTextParameters in interface WhatsAppTemplateMessageBuilder

externalUserId

public WhatsAppTemplateMessageBuilder externalUserId(String externalUserId)

Description copied from interface: WhatsAppTemplateMessageBuilder

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

Specified by:

externalUserId in interface WhatsAppTemplateMessageBuilder

businessAccountId

public WhatsAppTemplateMessageBuilder businessAccountId(String businessAccountId)

Description copied from interface: WhatsAppTemplateMessageBuilder

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

Specified by:

businessAccountId in interface WhatsAppTemplateMessageBuilder

messageId

public WhatsAppTemplateMessageBuilder messageId(String messageId)

Description copied from interface: WhatsAppTemplateMessageBuilder

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

Specified by:

messageId in interface WhatsAppTemplateMessageBuilder

send

public void send()

Description copied from interface: WhatsAppTemplateMessageBuilder

Perform the send of the template message.

Specified by:

send in interface WhatsAppTemplateMessageBuilder