Differences

This shows you the differences between two versions of the page.

--- mantisbt:notification_requirements [2008/07/07 14:08] – created jreese
+++ mantisbt:notification_requirements [2011/11/16 07:36] (current) – The page rendering was broken (maybe since new PHP version on mantisbt.org). Added new line to fix it at end of file. atrol
@@ Line 4: / Line 4: @@
    * **Status**: Draft
    * **Associated Issue**: http://www.mantisbt.org/bugs/view.php?id=9350
 ===== Introduction =====
-**Synopsis**: Design and implement infrastructure for notification events that are adaptable for use by Mantis core and plugins.
+Given the potential of the new event system in Mantis 1.2, and the current limitations and difficulties in the Mantis email notification subsystem, a more robust and extensible solution should be put in place.  The first piece of the solution involves creating an extensible infrastructure for generating and handling notifications of changes to projects and issues.  Once the framework is in place for notification events, the email system should be reworked to use the new notifications, and give users more options/features in the process.
+==== Goals ====
+  * Provide a simple "API" to create new notifications that can be used by the Mantis core and by plugins.
+  * Act as a stepping stone for creating a more robust replacement for the current email notifications.
+  * Allow for plugins to supplement email notification with other communication formats.
+  * Allow for plugins to add special data to notifications.
+==== Use Cases ====
+  * Allow developers to receive notifications when issues are updated using Twitter, SMS, or IRC.
+  * Allow the Source Integration plugin to generate notifications for issues when changesets are committed.
+  * Generate diff-style email notification reports for users.
 ===== Implementation Notes =====
@@ Line 13: / Line 27: @@
   * N/A
-==== Database Changes ====
+==== Hookable Events ====
+  * ''EVENT_NOTIFICATION'' (Execute)
+    * Generate appropriate notifications for a given type of notification.
+    * Parameters
+      * Notification object
+    * Return value
+      * N/A
-  * N/A
 ==== Configuration ====
@@ Line 30: / Line 50: @@
 ===== Feedback =====
   * Please provide feedback