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

Interface ExternalMessageBuilder

All Known Implementing Classes:
BaseExternalMessageBuilder, WeChatExternalMessageBuilder, WhatsAppExternalMessageBuilder
public interface ExternalMessageBuilder
Builder that can be used for sending external messages
Author:
Filip Hrisafov

  • Method Details

    • externalUserId

      ExternalMessageBuilder externalUserId​(java.lang.String externalUserId)
      The id of the external user to which the message should be send to
      Parameters:
      externalUserId - the external user id

    • businessAccountId

      ExternalMessageBuilder businessAccountId​(java.lang.String businessAccountId)
      The id of the business account for the external user
      Parameters:
      businessAccountId - the bussiness account id

    • messageId

      ExternalMessageBuilder messageId​(java.lang.String messageId)
      The id of the message being send (can be used for logging purposes)
      Parameters:
      messageId - the message id

    • message

      ExternalMessageBuilder message​(java.lang.String message)
      The contents of the message that needs to be send
      Parameters:
      message - the message content

    • sendMessage

      void sendMessage()
      Perform sending a normal text message

    • sendMediaMessage

      void sendMediaMessage​(java.lang.String mediaId)
      Perform sending of media message
      Parameters:
      mediaId - the id of the media that is being sent