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

Interface ChatStep

All Superinterfaces:
Comparable<com.novomind.ecom.common.api.persistence.Entity>, com.novomind.ecom.common.api.persistence.Entity, com.novomind.ecom.common.api.persistence.WithId
All Known Subinterfaces:
IncomingChatStep, OutgoingChatStep
public interface ChatStep extends com.novomind.ecom.common.api.persistence.Entity
ChatStep represents an event in the chat history.
Since:
11.3

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    ChatStep.ChatStepOrigin
    This enumeration describes the origin of a chat step.

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<ChatSession>
    getChatSession()
    Returns the chat session of this chat step.
    String
    getHtml()
    Returns the content of this chat step in html representation.
    ChatStep.ChatStepOrigin
    getOrigin()
    Returns the origin of this chat step.
    String
    getText()
    Returns the content of this chat step in text representation.
    Date
    getTimestamp()
    Returns the date when this chat step was created.

    Methods inherited from interface com.novomind.ecom.common.api.persistence.Entity

    compareTo, isDeleted, isNotDeleted

    Methods inherited from interface com.novomind.ecom.common.api.persistence.WithId

    getId

  • Method Details

    • getTimestamp

      Date getTimestamp()
      Returns the date when this chat step was created.
      Returns:
      the date when this chat step was created
      Since:
      11.3

    • getOrigin

      ChatStep.ChatStepOrigin getOrigin()
      Returns the origin of this chat step.
      Returns:
      the origin of this chat step
      Since:
      11.3

    • getText

      String getText()
      Returns the content of this chat step in text representation.
      Returns:
      the content of this chat step in text representation
      Since:
      11.3

    • getHtml

      String getHtml()
      Returns the content of this chat step in html representation.
      Returns:
      the content of this chat step in html representation
      Since:
      11.3

    • getChatSession

      Optional<ChatSession> getChatSession()
      Returns the chat session of this chat step.
      Returns:
      the chat session of this chat step. The optional contains either an AgentChatSession or a CustomerChatSession or a BotChatSession or it is empty if the chat step was triggered by the system.
      Since:
      11.21