.. include:: ../exports/alias.include

.. _statistics_backend_set_alert:

Set entity alert
----------------

Function |set_alert-api| allows the user to set an alert on a specific entity.
When the alert is triggered, the listener callback *on_alert_triggered* will be called with the corresponding parameters.
In addition, if no entity matches the alert, the listener callback *on_alert_timeout* will be called periodically
If a valid script is passed as an advanced parameter, it will be executed when the alert is triggered.

.. literalinclude:: /code/StatisticsBackendTests.cpp
   :language: c++
   :start-after: //CONF-SET-ALERT-EXAMPLE
   :end-before: //!
   :dedent: 8

To remove the alert, the user can call |remove_alert-api| with the id of the alert to be removed.

.. literalinclude:: /code/StatisticsBackendTests.cpp
   :language: c++
   :start-after: //CONF-REMOVE-ALERT-EXAMPLE
   :end-before: //!
   :dedent: 8