Class ZopimChatApi.SessionConfig

  • All Implemented Interfaces:
    java.io.Serializable
    Enclosing class:
    ZopimChatApi


    public static class ZopimChatApi.SessionConfig
    extends java.lang.Object
    Configuration class for session chat configuration

    Prepares new chat session config. Provided configuration will apply only to this session. Once configured call build() to return a ZopimChatApi instance to use.

    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      protected java.lang.String department 
      protected java.lang.String referrer 
      protected java.lang.String[] tags 
      protected java.lang.String title 
    • Constructor Summary

      Constructors 
      Constructor and Description
      SessionConfig() 
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      ChatApi build(FragmentActivity activity)
      Starts the chat session.
      T department(java.lang.String department)
      Sets department to the configuration builder.
      T tags(java.lang.String... tags)
      Sets tags to the configuration builder.
      T visitorPathOne(java.lang.String visitorPath)
      Sets visitor path as additional info visible in the Zopim chat dashboard.
      T visitorPathTwo(java.lang.String visitorPath)
      Sets visitor path as additional info visible in the Zopim chat dashboard.
      • Methods inherited from class java.lang.Object

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

      • department

        protected java.lang.String department
      • tags

        protected java.lang.String[] tags
      • title

        protected java.lang.String title
      • referrer

        protected java.lang.String referrer
    • Constructor Detail

      • SessionConfig

        public SessionConfig()
    • Method Detail

      • build

        public ChatApi build(FragmentActivity activity)
        Starts the chat session. Chat needs to be previously initialized.

        If session configuration was provided it will apply to this chat session. Otherwise if the global ZopimChatApi.DefaultConfig configuration is available it will be used to configure this chat session.

        It will start a service that represents chat session and will bind to that service. Service connection is managed by ChatServiceBinder

        Parameters:
        activity - that holds the chat session
        Returns:
        chat session instance
      • department

        public T department(java.lang.String department)
        Sets department to the configuration builder. Department will be visible in the Zopim chat dashboard.
        Parameters:
        department - name
        Returns:
        configuration builder
      • tags

        public T tags(java.lang.String... tags)
        Sets tags to the configuration builder. Tags will be visible in the Zopim chat dashboard.
        Parameters:
        tags - for the chat
        Returns:
        configuration builder
      • visitorPathOne

        public T visitorPathOne(java.lang.String visitorPath)
        Sets visitor path as additional info visible in the Zopim chat dashboard.

        Additional information configured in the dashboard used to help identify the origin of the chat.

        Parameters:
        visitorPath - as extra info visible on the dashboard
        Returns:
        configuration builder
      • visitorPathTwo

        public T visitorPathTwo(java.lang.String visitorPath)
        Sets visitor path as additional info visible in the Zopim chat dashboard.

        Additional information configured in the dashboard used to help identify the origin of the chat.

        Parameters:
        visitorPath - as extra info visible on the dashboard
        Returns:
        configuration builder