Package 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, Anatolii Balakiriev

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WhatsAppTemplateMessageBuilderImpl.ButtonComponentBuilderImpl
static class	WhatsAppTemplateMessageBuilderImpl.ComponentBuilderImpl
protected static enum	WhatsAppTemplateMessageBuilderImpl.Type

Nested classes/interfaces inherited from interface com.flowable.engage.external.system.whatsapp.api.WhatsAppTemplateMessageBuilder

WhatsAppTemplateMessageBuilder.ButtonComponentBuilder, WhatsAppTemplateMessageBuilder.ComponentBuilder

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
WhatsAppTemplateMessageBuilderImpl(WhatsAppJmsExternalConversationSystemAdapter whatsAppJmsExternalConversationSystemAdapter)

Method Summary

Modifier and Type	Method	Description
WhatsAppTemplateMessageBuilder	addTemplateTextParameter(String parameter)	Add a positional text parameter to the body.
WhatsAppTemplateMessageBuilder	addTemplateTextParameters(Collection<String> parameters)	Add positional text parameters to the body.
WhatsAppTemplateMessageBuilderImpl.ComponentBuilderImpl	body()	Initiates creation of the body.
WhatsAppTemplateMessageBuilder	businessAccountId(String businessAccountId)	The id of the business account that should be used when sending out the message.
WhatsAppTemplateMessageBuilderImpl.ButtonComponentBuilderImpl	button()	Initiates creation of the button.
WhatsAppTemplateMessageBuilder	externalUserId(String externalUserId)	The id of the recipient of the message.
WhatsAppTemplateMessageBuilderImpl.ComponentBuilderImpl	footer()	Initiates creation of the footer.
WhatsAppTemplateMessageBuilderImpl.ComponentBuilderImpl	header()	Initiates creation of the header.
WhatsAppTemplateMessageBuilder	language(String language)	The language of the template that should be used.
WhatsAppTemplateMessageBuilder	mediaHeader(String mediaId)	The content item ID for the media header.
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
WhatsAppTemplateMessageBuilder	timeToLive(Duration timeToLive)	Time To Live (TTL) duration.

Methods inherited from class java.lang.Object

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

Field Details

whatsAppJmsExternalConversationSystemAdapter

protected final WhatsAppJmsExternalConversationSystemAdapter whatsAppJmsExternalConversationSystemAdapter

templateMessage

protected final WhatsAppOutboundTemplateMessageDto templateMessage

Constructor Details

WhatsAppTemplateMessageBuilderImpl

public WhatsAppTemplateMessageBuilderImpl(WhatsAppJmsExternalConversationSystemAdapter whatsAppJmsExternalConversationSystemAdapter)

Method Details

timeToLive

public WhatsAppTemplateMessageBuilder timeToLive(Duration timeToLive)

Description copied from interface: WhatsAppTemplateMessageBuilder

Time To Live (TTL) duration.

Specified by:

timeToLive in interface WhatsAppTemplateMessageBuilder

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 to the body.

Short circuit for calling WhatsAppTemplateMessageBuilder.body(), then WhatsAppTemplateMessageBuilder.ComponentBuilder.addTextParameter(String) and then WhatsAppTemplateMessageBuilder.ComponentBuilder.buildComponent()

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 to the body.

Short circuit for calling WhatsAppTemplateMessageBuilder.body(), then WhatsAppTemplateMessageBuilder.ComponentBuilder.addTextParameter(String) and then WhatsAppTemplateMessageBuilder.ComponentBuilder.buildComponent()

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

header

public WhatsAppTemplateMessageBuilderImpl.ComponentBuilderImpl header()

Description copied from interface: WhatsAppTemplateMessageBuilder

Initiates creation of the header. After you are done building this component - call WhatsAppTemplateMessageBuilder.ComponentBuilder.buildComponent() method to build and add it to the parent builder.

Specified by:

header in interface WhatsAppTemplateMessageBuilder

Returns:

header-specific builder.

mediaHeader

public WhatsAppTemplateMessageBuilder mediaHeader(String mediaId)

Description copied from interface: WhatsAppTemplateMessageBuilder

The content item ID for the media header.

Specified by:

mediaHeader in interface WhatsAppTemplateMessageBuilder

Parameters:

mediaId - the media header

body

public WhatsAppTemplateMessageBuilderImpl.ComponentBuilderImpl body()

Description copied from interface: WhatsAppTemplateMessageBuilder

Initiates creation of the body. After you are done building this component - call WhatsAppTemplateMessageBuilder.ComponentBuilder.buildComponent() method to build and add it to the parent builder.

Specified by:

body in interface WhatsAppTemplateMessageBuilder

Returns:

body-specific builder.

footer

public WhatsAppTemplateMessageBuilderImpl.ComponentBuilderImpl footer()

Description copied from interface: WhatsAppTemplateMessageBuilder

Initiates creation of the footer. After you are done building this component - call WhatsAppTemplateMessageBuilder.ComponentBuilder.buildComponent() method to build and add it to the parent builder.

Specified by:

footer in interface WhatsAppTemplateMessageBuilder

Returns:

footer-specific builder.

button

public WhatsAppTemplateMessageBuilderImpl.ButtonComponentBuilderImpl button()

Description copied from interface: WhatsAppTemplateMessageBuilder

Initiates creation of the button. After you are done building this component - call WhatsAppTemplateMessageBuilder.ComponentBuilder.buildComponent() method to build and add it to the parent builder.

Specified by:

button in interface WhatsAppTemplateMessageBuilder

Returns:

button-specific builder.