Package zendesk.chat.client

Class ChatState


  • public class ChatState
extends java.lang.Object
    Represents the current state of the chat.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static int NO_QUEUE_POSITION
      Value for position denoting that the visitor is not in the queue.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      boolean equals(java.lang.Object o) 
      java.util.List<Agent> getAgents()
      Returns list of agents in the chat.
      java.lang.String getChatComment()
      Returns the current comment about chat experience given by the visitor.
      java.util.List<ChatLog> getChatLogs()
      Returns the chat logs for this chat.
      ChatRating getChatRating()
      Returns the current chat rating given by the visitor.
      Department getDepartment()
      Returns the selected department for this chat, if one has been selected.
      int getQueuePosition()
      Returns the queue position of the visitor.
      int hashCode() 
      boolean isChatting()
      Returns true if visitor sent or received a message, false otherwise.
      java.lang.String toString() 

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • NO_QUEUE_POSITION

        public static final int NO_QUEUE_POSITION
        Value for position denoting that the visitor is not in the queue.
        See Also:
        Constant Field Values

    • Method Detail

      • getChatLogs

        public java.util.List<ChatLog> getChatLogs()
        Returns the chat logs for this chat.
        See Also:
        ChatLog

      • getAgents

        public java.util.List<Agent> getAgents()
        Returns list of agents in the chat.
        See Also:
        Agent

      • isChatting

        public boolean isChatting()
        Returns true if visitor sent or received a message, false otherwise.

      • getChatRating

        public ChatRating getChatRating()
        Returns the current chat rating given by the visitor.
        Returns:
        ChatRating or null if this chat has not been rated yet.

      • getChatComment

        public java.lang.String getChatComment()
        Returns the current comment about chat experience given by the visitor.
        Returns:
        Comment about the chat or null if this chat has not been commented yet.

      • getDepartment

        public Department getDepartment()
        Returns the selected department for this chat, if one has been selected.
        Returns:
        An instance of Department or null if department is not selected.

      • equals

        public boolean equals(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object