.. role:: ts-api-decorator

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

.. js:module:: cee
   :noindex:

.. container:: ts-api-section

   .. js:class:: 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 ``enableInfo`` function to turn on/off info logging from EnvisionWeb. 

      Use the ``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.



.. container:: api-index-section

   .. rubric:: Constructors

   .. rst-class:: api-index-list-item api-kind-constructor api-parent-kind-class

   * :js:meth:`~cee.Logger.constructor`



.. container:: api-index-section

   .. rubric:: Properties

   .. rst-class:: api-index-list-item api-kind-property api-parent-kind-class

   * :js:attr:`~cee.Logger.debug`
   * :js:attr:`~cee.Logger.error`
   * :js:attr:`~cee.Logger.info`
   * :js:attr:`~cee.Logger.warn`



.. container:: api-index-section

   .. rubric:: Methods

   .. rst-class:: api-index-list-item api-kind-method api-parent-kind-class

   * :js:meth:`~cee.Logger.enableDebug`
   * :js:meth:`~cee.Logger.enableInfo`





------------

Constructors
============

.. container:: ts-api-section

   .. js:function:: Logger.constructor()



      :rtype: Logger



Properties
==========

.. container:: ts-api-section

   .. js:attribute:: Logger.debug

      :type: function




      .. js:function:: debug( _msg)
         :noindex:

         :param _msg: None
         :type _msg: string


         Logs a debug message. Will be shown if debug messages are enabled.


         :rtype: void





.. container:: ts-api-section

   .. js:attribute:: Logger.error

      :type: any

      Logs an error message.



.. container:: ts-api-section

   .. js:attribute:: Logger.info

      :type: function




      .. js:function:: info( _msg)
         :noindex:

         :param _msg: None
         :type _msg: string


         Logs an info message. Will be shown if info messages are enabled.


         :rtype: void





.. container:: ts-api-section

   .. js:attribute:: Logger.warn

      :type: any

      Logs a warning message.



Methods
=======

.. rst-class:: ts-api-section

:ts-api-decorator:`static` enableDebug
--------------------------------------

.. js:method:: Logger.enableDebug( enable)

   :param enable: None
   :type enable: boolean


   Enables/disables debug log messages.

   Debug log messages contain detailed debug information about the client and communication with the server.


   :rtype: void

.. rst-class:: ts-api-section

:ts-api-decorator:`static` enableInfo
-------------------------------------

.. js:method:: Logger.enableInfo( enable)

   :param enable: None
   :type enable: boolean


   Enables/disables info log messages.

   Info log messages contain information about the client and communication with the server.


   :rtype: void

