Edgewall Software

Changes between Version 5 and Version 6 of TracDev/NotificationApi


Ignore:
Timestamp:
Jul 31, 2015, 2:17:33 PM (4 years ago)
Author:
figaro
Comment:

Cosmetic changes, added link to Open questions

Legend:

Unmodified
Added
Removed
Modified
  • TracDev/NotificationApi

    v5 v6  
    1 [[PageOutline(2-3)]]
     1[[PageOutline(2-3,Contents)]]
    22
    33= Trac Notification API
    44
    5 == New API
    6 ''(since Trac 1.1.3)''
     5== Current API
    76
    8 The new API keeps the `IEmailSender` extension point and the `NotificationSystem` component almost unchanged from the [#OldAPI old API], but deprecates the entire `Notify` hierarchy.
     7Since Trac 1.1.3.
     8
     9The current API keeps the `IEmailSender` extension point and the `NotificationSystem` component almost unchanged from the [#PreviousAPI previous API], but deprecates the entire `Notify` hierarchy.
    910
    1011It is replaced by a new class hierarchy. An instance of such a class contains all known data about an event that requires sending notifications:
     
    1617
    1718=== !NotificationEvent
     19
    1820Contains the following properties:
    1921* `realm`: a string of the affected resource realm (e.g. `'ticket'` or `'wiki'`)
     
    2426
    2527=== !TicketChangeEvent
     28
    2629* `realm` is 'ticket'.
    2730* Known values for `category` are `'created'`, `'changed'`, `'attachment added'` and `'attachment deleted'`.
     
    3336
    3437=== !BatchTicketChangeEvent
     38
    3539* `realm` is 'ticket'.
    3640* `category` is 'batchmodify'.
     
    4145  * `action`: a ticket action controller action
    4246
    43 == Old API
    44 ''(since Trac 0.7, deprecated since Trac 1.1.3)''
     47See also: /TracDev/Proposals/AdvancedNotification/NotificationApi#OpenQuestions
     48
     49== Previous API
     50
     51Since Trac 0.7, deprecated since Trac 1.1.3.
    4552
    4653The original notification API consisted mainly of a class hierarchy: