Package com.novomind.ecom.api.iagent.message

Class OutgoingMessageHandler.SendOptions

java.lang.Object
com.novomind.ecom.api.iagent.message.OutgoingMessageHandler.SendOptions
Enclosing interface:
OutgoingMessageHandler
public static final class OutgoingMessageHandler.SendOptions extends Object
Represents options to send a message
Since:
12.9

  • Method Details

    • defaults

      public static OutgoingMessageHandler.SendOptions defaults()
      Creates an instance of SendOptions using defaults.
      Returns:
      an instance of SendOptions with default settings.
      Since:
      12.9

    • isClearanceRequired

      public boolean isClearanceRequired()
      If this option is enabled the message will stay on the outgoing folder and wait for clearance to be applied manually by a supervisor. When the supervisor has applied clearance the message will be sent by the corresponding Account.
      Returns:
      true if clearance is required, otherwise false (default)
      Since:
      12.9

    • setClearanceRequired

      public OutgoingMessageHandler.SendOptions setClearanceRequired(boolean clearanceRequired)
      This option enforces a clearance authorization of the message before being sent. The message will stay on the outgoing folder and wait for clearance to be applied manually by a supervisor. When the supervisor has applied clearance the message will be sent by the corresponding Account.
      Parameters:
      clearanceRequired - if true clearance authorization by supervisor is required before sending the message
      Returns:
      this
      Since:
      12.9

    • isIgnoreErrors

      public boolean isIgnoreErrors()
      If this option is enabled the message will be deleted in case of a PermanentMessagingException thrown by the MessageConnector on send without any further action or notice. If this option is disabled (default) the message will stay red flagged on the outgoing folder in case of a PermanentMessagingException on send. In this case manual action by a supervisor is required. The supervisor can either retry to send the message or delete the message.
      Returns:
      true if permanent send errors will be ignored and the message will be deleted, otherwise false (default)
      Since:
      12.9

    • setIgnoreErrors

      public OutgoingMessageHandler.SendOptions setIgnoreErrors(boolean ignoreErrors)
      If this option is set the message will be deleted in case of a PermanentMessagingException thrown by the MessageConnector on send without any further action or notice.
      Parameters:
      ignoreErrors - if true the message will be deleted from the outgoing folder in case of permanent send errors without any further action
      Returns:
      this
      Since:
      12.9