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

Interface InboundMessageBuilder

All Known Implementing Classes:
InboundMessageBuilderImpl
public interface InboundMessageBuilder
Builder for sending inbound messages (messages from external adapters) to the engage platform.
Author:
Filip Hrisafov

  • Method Details

    • externalSenderName

      InboundMessageBuilder externalSenderName​(java.lang.String externalSenderName)

    • externalSenderId

      InboundMessageBuilder externalSenderId​(java.lang.String externalSenderId)
      The external id of the user that send the message
      Parameters:
      externalSenderId - the external id of the sender

    • externalSystemId

      InboundMessageBuilder externalSystemId​(java.lang.String externalSystemId)
      The id of the system that the message originates from.
      Parameters:
      externalSystemId - the system id
      See Also:
      ExternalSystemIds

    • businessAccountId

      InboundMessageBuilder businessAccountId​(java.lang.String businessAccountId)
      The id of the business account that has received the message. (e.g. WhatsApp business number, WeChat official account, etc)
      Parameters:
      businessAccountId - the id of the business account

    • externalId

      InboundMessageBuilder externalId​(java.lang.String externalId)
      The optional external id of the message in the external system.
      Parameters:
      externalId - the external id

    • replyToExternalId

      InboundMessageBuilder replyToExternalId​(java.lang.String replyToExternalId)
      The optional reply to external id of the message in the external system. This would be used to create a reply to message in the engage system
      Parameters:
      replyToExternalId - the external id

    • messageType

      InboundMessageBuilder messageType​(java.lang.String messageType)

    • messageSubType

      InboundMessageBuilder messageSubType​(java.lang.String messageSubType)

    • content

      InboundMessageBuilder content​(java.lang.String content)
      The content of the message
      Parameters:
      content - the message content

    • contentType

      InboundMessageBuilder contentType​(java.lang.String contentType)
      The type of the content for the message.
      Parameters:
      contentType - the message content type

    • externalMediaId

      InboundMessageBuilder externalMediaId​(java.lang.String externalMediaId)
      The id of the external media.
      Parameters:
      externalMediaId - the external media id

    • externalMediaName

      InboundMessageBuilder externalMediaName​(java.lang.String externalMediaName)
      The name of the external media.
      Parameters:
      externalMediaName - the external media name

    • externalMediaMimeType

      InboundMessageBuilder externalMediaMimeType​(java.lang.String externalMediaMimeType)
      The mime type of the external media.
      Parameters:
      externalMediaMimeType - the external media mime type

    • send

      void send()
      Perform the actual message send to the engage platform

    • sendUnsupported

      void sendUnsupported()
      Perform sending the message as an unsupported type. This is usually decided by the invokers of the builders.