diff -r 76ab3c71aff2 -r c67bcee93248 doc/book/devrepo/repo/notifications.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/book/devrepo/repo/notifications.rst Thu Jan 08 22:11:06 2015 +0100 @@ -0,0 +1,29 @@ +.. -*- 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