Package com.flowable.engage.external.system.whatsapp.api

Interface WhatsAppTemplateMessageBuilder.ComponentBuilder

All Known Implementing Classes:
WhatsAppTemplateMessageBuilderImpl.ComponentBuilderImpl
Enclosing interface:
WhatsAppTemplateMessageBuilder
public static interface WhatsAppTemplateMessageBuilder.ComponentBuilder

  • Method Details

    • addTextParameter

      WhatsAppTemplateMessageBuilder.ComponentBuilder addTextParameter​(java.lang.String value)
      Add simple text parameter

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

      Parameters:
      value - text value
      Returns:
      current component builder.

    • addImageLinkParameter

      WhatsAppTemplateMessageBuilder.ComponentBuilder addImageLinkParameter​(java.lang.String link)
      Add image link parameter

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

      Parameters:
      link - to the image
      Returns:
      current component builder.

    • addCurrencyParameter

      WhatsAppTemplateMessageBuilder.ComponentBuilder addCurrencyParameter​(java.lang.String fallbackValue, java.lang.String code, java.math.BigDecimal amount)
      Add currency parameter. The currency to be displayed is dependent on the client's language/locale.

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

      Parameters:
      fallbackValue - default value, if the device is unsuccessful in localizing a parameter, it should fall back to using the fallbackValue (e.g. $100.99)
      code - currency code as defined in ISO 4217 (e.g. USD)
      amount - amount multiplied by 1000 (e.g. 100990 is 100.99)
      Returns:
      current component builder.

    • addDateTimeParameter

      WhatsAppTemplateMessageBuilder.ComponentBuilder addDateTimeParameter​(java.lang.String fallbackValue, java.time.LocalDateTime dateTime, java.lang.String calendar)
      Add date time parameter. The time specified will be the same, regardless of the time zone the client is in.

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

      Parameters:
      fallbackValue - default value, if the device is unsuccessful in localizing a parameter, it should fall back to using the fallbackValue
      dateTime - time as LocalDateTime
      calendar - type of calendar. Optional.
      Returns:
      current component builder.

    • buildComponent

      WhatsAppTemplateMessageBuilder buildComponent()
      Builds current component (header, body, footer or button) and adds it to the list of components of the parent builder.
      Returns:
      parent builder.