doc/book/devrepo/repo/notifications.rst
author Philippe Pepiot <philippe.pepiot@logilab.fr>
Thu, 19 Jan 2017 15:27:39 +0100
changeset 11899 bf6106b91633
parent 10491 c67bcee93248
permissions -rw-r--r--
[schema] load schema from modules names instead of directories Introspect cubicweb, cubes and apphome using pkgutil to generate the full list of modules names for loading the schema. Keep historical behavior and check if source .py file exists if a module is found using python bytecode file (.pyc and .pyo) Loading schema from apphome require apphome to be present in sys.path and that "schema" module resolve to a file located in apphome. Update migraction tests to explicitely update sys.path when loading schema from different apps, use a contextmanager for this so it's more readable. Require updated logilab-common and yams

.. -*- coding: utf-8 -*-

Notifications management
========================

CubicWeb provides a machinery to ease notifications handling. To use it for a
notification:

* write a view inheriting from
  :class:`~cubicweb.sobjects.notification.NotificationView`.  The usual view api
  is used to generated the email (plain text) content, and additional
  :meth:`~cubicweb.sobjects.notification.NotificationView.subject` and
  :meth:`~cubicweb.sobjects.notification.NotificationView.recipients` methods
  are used to build the email's subject and
  recipients. :class:`NotificationView` provides default implementation for both
  methods.

* write a hook for event that should trigger this notification, select the view
  (without rendering it), and give it to
  :func:`cubicweb.hooks.notification.notify_on_commit` so that the notification
  will be sent if the transaction succeed.


.. XXX explain recipient finder and provide example

API details
~~~~~~~~~~~
.. autoclass:: cubicweb.sobjects.notification.NotificationView
.. autofunction:: cubicweb.hooks.notification.notify_on_commit