diff options
| author | icewing <icewing@36083f99-b078-4883-b0ff-0f9b5a30f544> | 2008-06-04 11:10:02 +0000 |
|---|---|---|
| committer | icewing <icewing@36083f99-b078-4883-b0ff-0f9b5a30f544> | 2008-06-04 11:10:02 +0000 |
| commit | 7a439878064085f6d2dd14e7f76fb61149928729 (patch) | |
| tree | 459f4430d0065f1cd2323935d3c857a00d203187 | |
| parent | b60ef4114772f1b14cb8ab08c343742c13209a2a (diff) | |
| download | elgg-7a439878064085f6d2dd14e7f76fb61149928729.tar.gz elgg-7a439878064085f6d2dd14e7f76fb61149928729.tar.bz2 | |
Marcus Povey <marcus@dushka.co.uk>
* Documentation
git-svn-id: https://code.elgg.org/elgg/trunk@789 36083f99-b078-4883-b0ff-0f9b5a30f544
| -rw-r--r-- | engine/lib/notification.php | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/engine/lib/notification.php b/engine/lib/notification.php index 15448f720..fd4f3a9d0 100644 --- a/engine/lib/notification.php +++ b/engine/lib/notification.php @@ -3,6 +3,16 @@ * Notifications * This file contains classes and functions which allow plugins to register and send notifications. * + * There are notification methods which are provided out of the box (see notification_init() ). Each method + * is identified by a string, e.g. "email". + * + * To register an event use register_notification_handler() and pass the method name and a handler function. + * + * To send a notification call notify() passing it the method you wish to use combined with a number of method + * specific addressing parameters. + * + * Catch NotificationException to trap errors. + * * @package Elgg * @subpackage API * @license http://www.gnu.org/licenses/old-licenses/gpl-2.0.html GNU Public License version 2 |