========================
Module: ``hintMessages``
========================


.. contents:: Local Navigation
   :local:

Children
========

.. toctree::
   :maxdepth: 1
   
   module-hintMessages-_CaosDBModules
   module-hintMessages-_CaosDBModules
   module-hintMessages-_CaosDBModules
   
Description
===========




.. _module-hintMessages.createErrorNotification:


Function: ``createErrorNotification``
=====================================



.. js:function:: createErrorNotification()

    
    
.. _module-hintMessages.createWaitingNotification:


Function: ``createWaitingNotification``
=======================================

Create a waiting notification with a informative message for the waiting user.

.. js:function:: createWaitingNotification(info,, id,)

    
    :param String info,: a message for the user
    :param String id,: optional, the id of the message div.  Default is empty
    :return HTMLElement: A div with class `caosdb-preview-waiting-notification`.
    
.. _module-hintMessages.removeAllWaitingNotifications:


Function: ``removeAllWaitingNotifications``
===========================================

Remove all waiting notifications from an element.

.. js:function:: removeAllWaitingNotifications(elem)

    
    :param HTMLElement elem: Remove all waiting notifications from an element.
    :return HTMLElement: The parameter `elem`.
    
.. _module-hintMessages.postXml:


Function: ``postXml``
=====================

Post an xml document to basepath/Entity

.. js:function:: postXml()

    
    :param postXml(): XML document
    :param postXml(): string
    :param postXml(): string
    :param postXml(): integer (in milliseconds)
    :return postXml(): Promise object
    
.. _module-hintMessages.xml2str:


Function: ``xml2str``
=====================

Serialize an xml document into plain string.

.. js:function:: xml2str()

    
    :param xml2str(): Serialize an xml document into plain string.
    :return xml2str(): string representation of xml
    
.. _module-hintMessages.load_config:


Function: ``load_config``
=========================

Load a json configuration.

If the file cannot be found, an empty array is returned.

.. js:function:: load_config()

    
    :param load_config(): The filename of the configuration file residing in conf/.
    :return load_config(): object containing the configuration
    
.. _module-hintMessages.str2xml:


Function: ``str2xml``
=====================

Convert a string into an xml document.

.. js:function:: str2xml()

    
    :param str2xml(): a string representation of an xml document.
    :return str2xml(): an xml document.
    
.. _module-hintMessages.asyncXslt:


Function: ``asyncXslt``
=======================

Asynchronously transform an xml into html via xslt.

.. js:function:: asyncXslt()

    
    :param asyncXslt(): resolves to an input xml document.
    :param asyncXslt(): resolves to a xsl script.
    :param asyncXslt(): resolves to parameters for the xsl script.
    :return asyncXslt(): A promise which resolves to a generated HTML document.
    
.. _module-hintMessages.xslt:


Function: ``xslt``
==================

transform a xml into html via xslt

.. js:function:: xslt()

    
    :param xslt(): the input xml document
    :param xslt(): the transformation script
    :param xslt(): xsl parameter to be set (optionally).
    :return xslt(): html
    
.. _module-hintMessages.getXSLScriptClone:


Function: ``getXSLScriptClone``
===============================

TODO

.. js:function:: getXSLScriptClone()

    
    
.. _module-hintMessages.injectTemplate:


Function: ``injectTemplate``
============================

Add a template rule to a XSL style sheet.

The original document is cloned (copy-on-change) before the template rule is
appended.

.. js:function:: injectTemplate(orig_xsl, templateStr)

    
    :param XMLDocument orig_xsl: the original xsl style sheet
    :param string templateStr: the new template rule (an xml string)
    :return XMLDocument: new xsl style sheet with one more rule.
    
.. _module-hintMessages.insertParam:


Function: ``insertParam``
=========================

TODO

.. js:function:: insertParam()

    
    
.. _module-hintMessages.initOnDocumentReady:


Function: ``initOnDocumentReady``
=================================

Initialize all the submodules.

.. js:function:: initOnDocumentReady()

    
    

.. _module-hintMessages.hintMessages:

Member: ``hintMessages``: 

.. _module-hintMessages.id:

Member: ``id``: 

.. _module-hintMessages.type:

Member: ``type``: 

.. _module-hintMessages.contentType:

Member: ``contentType``: 

.. _module-hintMessages.url:

Member: ``url``: 

.. _module-hintMessages.processData:

Member: ``processData``: 

.. _module-hintMessages.data:

Member: ``data``: 

.. _module-hintMessages.dataType:

Member: ``dataType``: 

.. _module-hintMessages.timeout:

Member: ``timeout``: 

.. _module-hintMessages.statusCode:

Member: ``statusCode``: 

.. _module-hintMessages.url:

Member: ``url``: 

.. _module-hintMessages.dataType:

Member: ``dataType``: 

.. _module-hintMessages.result:

Member: ``result``: 

.. _module-hintMessages.result:

Member: ``result``: 

.. _module-hintMessages.user_management:

Member: ``user_management``: 

.. _module-hintMessages.type:

Member: ``type``: 

.. _module-hintMessages.url:

Member: ``url``: 

.. _module-hintMessages.dataType:

Member: ``dataType``: 

.. _module-hintMessages.data:

Member: ``data``: 

.. _module-hintMessages.modal:

Member: ``modal``: 

.. _module-hintMessages.msg_text:

Member: ``msg_text``: 

.. _module-hintMessages.msg_text:

Member: ``msg_text``: 

.. _module-hintMessages.msg_text:

Member: ``msg_text``: 

.. _module-hintMessages.init:

Member: ``init``: 

.. _module-hintMessages.set_new_password:

Member: ``set_new_password``: 

.. _module-hintMessages.get_change_password_form:

Member: ``get_change_password_form``: 

.. _module-hintMessages.caosdb_modules:

Member: ``caosdb_modules``: