Package com.novomind.ecom.api.iagent.chat.history.model

Class ExternalChatHistory

java.lang.Object
com.novomind.ecom.api.iagent.chat.history.model.ExternalChatHistory
public final class ExternalChatHistory extends Object
Represents an external chat history provided by an ExternalChatHistoryProvider.
Since:
13.12

  • Constructor Details

    • ExternalChatHistory

      public ExternalChatHistory()
      Constructs a new external chat history without start and end date and without a nickname for the external system.
      Since:
      13.12

    • ExternalChatHistory

      public ExternalChatHistory(Date chatStart, Date chatEnd)
      Constructs a new external chat history with the specified start and end date and without a nickname for the external system.
      Parameters:
      chatStart - the start date of the external chat history
      chatEnd - the end date of the external chat history
      Since:
      13.12

    • ExternalChatHistory

      public ExternalChatHistory(Date chatStart, Date chatEnd, String externalSystemNickname)
      Constructs a new external chat history with the specified start and end date and the nickname for the external system.
      Parameters:
      chatStart - the start date of the external chat history
      chatEnd - the end date of the external chat history
      externalSystemNickname - the nickname of the external system that was used for sending chat messages
      Since:
      13.12

  • Method Details

    • getChatStart

      public Date getChatStart()
      This method return the start date of the external chat history.
      Returns:
      the start date of the external chat history
      Since:
      13.12

    • getChatEnd

      public Date getChatEnd()
      This method returns the end date of the external chat history.
      Returns:
      the end date of the external chat history
      Since:
      13.12

    • getExternalSystemNickname

      public String getExternalSystemNickname()
      This method returns the nickname of the external system that was used for sending chat messages
      Returns:
      the nickname of the external system that was used for sending chat messages
      Since:
      13.12

    • getExternalChatHistoryMessages

      public List<ExternalChatHistoryMessage> getExternalChatHistoryMessages()
      This method returns an unmodifiable list of the external chat history messages currently held inside this external chat history object.
      Returns:
      an unmodifiable list of the external chat history messages currently held inside this external chat history object
      Since:
      13.12

    • addIncomingExternalChatHistoryTextMessage

      public void addIncomingExternalChatHistoryTextMessage(IncomingExternalChatHistoryTextMessage incomingExternalChatHistoryTextMessage)
      Add a new incoming external chat history text message to the list of messages.
      Parameters:
      incomingExternalChatHistoryTextMessage - the incoming external chat history text message to add
      Since:
      13.12

    • addIncomingExternalChatHistoryRawMessage

      public void addIncomingExternalChatHistoryRawMessage(IncomingExternalChatHistoryRawMessage incomingExternalChatHistoryRawMessage)
      Add a new incoming external chat history raw message to the list of messages.
      Parameters:
      incomingExternalChatHistoryRawMessage - the incoming external chat history raw message to add
      Since:
      13.12

    • addIncomingExternalChatHistoryMediaDataMessage

      public void addIncomingExternalChatHistoryMediaDataMessage(IncomingExternalChatHistoryMediaDataMessage incomingExternalChatHistoryMediaDataMessage)
      Add a new incoming external chat history media data message to the list of messages.
      Parameters:
      incomingExternalChatHistoryMediaDataMessage - the incoming external chat history media data message to add
      Since:
      13.12

    • addIncomingExternalChatHistoryMediaUrlMessage

      public void addIncomingExternalChatHistoryMediaUrlMessage(IncomingExternalChatHistoryMediaUrlMessage incomingExternalChatHistoryMediaUrlMessage)
      Add a new incoming external chat history media url message to the list of messages.
      Parameters:
      incomingExternalChatHistoryMediaUrlMessage - the incoming external chat history media url message to add
      Since:
      13.12

    • addOutgoingExternalChatHistoryTextMessage

      public void addOutgoingExternalChatHistoryTextMessage(OutgoingExternalChatHistoryTextMessage outgoingExternalChatHistoryTextMessage)
      Add a new outgoing external chat history text message to the list of messages.
      Parameters:
      outgoingExternalChatHistoryTextMessage - the outgoing external chat history text message to add
      Since:
      13.12

    • addOutgoingExternalChatHistoryRawMessage

      public void addOutgoingExternalChatHistoryRawMessage(OutgoingExternalChatHistoryRawMessage outgoingExternalChatHistoryRawMessage)
      Add a new outgoing external chat history raw message to the list of messages.
      Parameters:
      outgoingExternalChatHistoryRawMessage - the outgoing external chat history raw message to add
      Since:
      13.12

    • addOutgoingExternalChatHistoryMediaDataMessage

      public void addOutgoingExternalChatHistoryMediaDataMessage(OutgoingExternalChatHistoryMediaDataMessage outgoingExternalChatHistoryMediaDataMessage)
      Add a new outgoing external chat history media data message to the list of messages.
      Parameters:
      outgoingExternalChatHistoryMediaDataMessage - the outgoing external chat history media data message to add
      Since:
      13.12

    • addOutgoingExternalChatHistoryMediaUrlMessage

      public void addOutgoingExternalChatHistoryMediaUrlMessage(OutgoingExternalChatHistoryMediaUrlMessage outgoingExternalChatHistoryMediaUrlMessage)
      Add a new outgoing external chat history media url message to the list of messages.
      Parameters:
      outgoingExternalChatHistoryMediaUrlMessage - the outgoing external chat history media url message to add
      Since:
      13.12