Class VisitorInfo

  • All Implemented Interfaces:
    java.io.Serializable


    public class VisitorInfo
    extends java.lang.Object
    implements java.io.Serializable
    This is a model class for visitor information that can be passed as part of config parameters when starting a chat.

    It is used as a configuration parameter in ZopimChatApi to configure information about the user that is in the chat. Setting this configuration to ZopimChatApi will make the information visible in the agent's dashboard.

    This class is a model that will be serialised to JSON and deserialised from JSON to this model. As such it does not follow the m naming prefix for fields.

    See Also:
    ZopimChatApi.setVisitorInfo(VisitorInfo), Agent Dashboard, Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class and Description
      static class  VisitorInfo.Builder
      Visitor info builder class
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getEmail()
      Gets visitor email configured for this user
      java.lang.String getName()
      Gets visitor name configured for this user
      java.lang.String getNote()
      Gets visitor note
      java.lang.String getPhoneNumber()
      Gets visitor phone number configured for this user
      void setEmail(java.lang.String email)
      Sets visitor email to this configuration model
      void setName(java.lang.String name)
      Sets visitor name to this configuration model
      void setNote(java.lang.String note)
      Appends a note to the visitor note
      void setPhoneNumber(java.lang.String phoneNumber)
      Sets visitor phone number to this configuration model
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • getName

        public java.lang.String getName()
        Gets visitor name configured for this user
        Returns:
        name
      • setName

        public void setName(java.lang.String name)
        Sets visitor name to this configuration model
        Parameters:
        name - of the visitor
      • getEmail

        public java.lang.String getEmail()
        Gets visitor email configured for this user
        Returns:
        email of the visitor
      • setEmail

        public void setEmail(java.lang.String email)
        Sets visitor email to this configuration model
        Parameters:
        email - of the visitor
      • getPhoneNumber

        public java.lang.String getPhoneNumber()
        Gets visitor phone number configured for this user
        Returns:
        phoneNumber
      • setPhoneNumber

        public void setPhoneNumber(java.lang.String phoneNumber)
        Sets visitor phone number to this configuration model
        Parameters:
        phoneNumber - of the visitor
      • setNote

        public void setNote(java.lang.String note)
        Appends a note to the visitor note
        Parameters:
        note - about the visitor
      • getNote

        public java.lang.String getNote()
        Gets visitor note
        Returns:
        note