.. role:: clio-static
   :class: clio-flag clio-flag-static


######
Logger
######

.. js:class:: cee.Logger

   The logger used in HOOPS Envision for Web (EnvisionWeb)
   
   Static class for controlling the log output from EnvisionWeb, and for logging within the client app.
   
   Use the :js:meth:`enableInfo <static cee.Logger.enableInfo>` function to turn on/off info logging from EnvisionWeb.
   
   Use the :js:meth:`enableDebug <static cee.Logger.enableDebug>` function to turn on/off debug logging from EnvisionWeb.
   
   These should only be used for debugging and should be disabled in a production environment.
   
   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~cee.Logger.constructor`
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~cee.Logger.debug`
   * :js:data:`~cee.Logger.error`
   * :js:data:`~cee.Logger.info`
   * :js:data:`~cee.Logger.warn`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~static cee.Logger.enableDebug`
   * :js:meth:`~static cee.Logger.enableInfo`
   
   



.. rst-class:: kind-group kind-constructors

.. rubric:: Constructors
   :class: kind-group-title


.. js:method:: cee.Logger.constructor

      .. rst-class:: sig-pretty-signature
      
         | Logger(): :js:class:`Logger <cee.Logger>`
      
      **Returns**\ : :js:class:`Logger <cee.Logger>`
      



.. rst-class:: kind-group kind-properties

.. rubric:: Properties
   :class: kind-group-title


.. js:data:: cee.Logger.debug

      .. rst-class:: clio-flags
      
         :clio-static:`static`
      
      .. rst-class:: sig-pretty-signature
      
         | debug: (**_msg**\ : *string*\ ) => *void*
      
      Logs a debug message. Will be shown if debug messages are enabled.
      



.. js:data:: cee.Logger.error

      .. rst-class:: clio-flags
      
         :clio-static:`static`
      
      .. rst-class:: sig-pretty-signature
      
         | error: *any*
      
      Logs an error message.
      



.. js:data:: cee.Logger.info

      .. rst-class:: clio-flags
      
         :clio-static:`static`
      
      .. rst-class:: sig-pretty-signature
      
         | info: (**_msg**\ : *string*\ ) => *void*
      
      Logs an info message. Will be shown if info messages are enabled.
      



.. js:data:: cee.Logger.warn

      .. rst-class:: clio-flags
      
         :clio-static:`static`
      
      .. rst-class:: sig-pretty-signature
      
         | warn: *any*
      
      Logs a warning message.
      



.. rst-class:: kind-group kind-methods

.. rubric:: Methods
   :class: kind-group-title


.. js:method:: static cee.Logger.enableDebug

      .. rst-class:: clio-flags
      
         :clio-static:`static`
      
      .. rst-class:: sig-pretty-signature
      
         | enableDebug(**enable**\ : *boolean*\ ?): *void*
      
      Enables/disables debug log messages.
      
      Debug log messages contain detailed debug information about the client and communication with the server.
      
      **Parameters**
      
      
         **enable**\ : *boolean* = true
      
      
      **Returns**\ : *void*
      



.. js:method:: static cee.Logger.enableInfo

      .. rst-class:: clio-flags
      
         :clio-static:`static`
      
      .. rst-class:: sig-pretty-signature
      
         | enableInfo(**enable**\ : *boolean*\ ?): *void*
      
      Enables/disables info log messages.
      
      Info log messages contain information about the client and communication with the server.
      
      **Parameters**
      
      
         **enable**\ : *boolean* = true
      
      
      **Returns**\ : *void*
      




