Edgewall Software

Changes between Version 3 and Version 4 of TracDev/Proposals/AdvancedNotification/NotificationApi


Ignore:
Timestamp:
Nov 29, 2014, 7:00:25 PM (9 years ago)
Author:
Peter Suter
Comment:

Update milestone, known categories

Legend:

Unmodified
Added
Removed
Modified
  • TracDev/Proposals/AdvancedNotification/NotificationApi

    v3 v4  
    44
    55== Old API
    6 ''(since Trac 0.7, deprecated since Trac 1.1.2)''
     6''(since Trac 0.7, deprecated since Trac 1.1.3)''
    77
    88The original notification API consisted mainly of a class hierarchy:
     
    2121
    2222== New API
    23 ''(since Trac 1.1.2)''
     23''(since Trac 1.1.3)''
    2424
    2525The new API keeps the `IEmailSender` extension point entirely and the `NotificationSystem` component almost unchanged, but deprecates the entire `Notify` hierarchy.
     
    3434=== !NotificationEvent
    3535Contains the following properties:
    36 * `realm`: a string of the affected resource realm (e.g. 'ticket' or 'wiki')
    37 * `category`: a string to identify the category of event (e.g. 'created', 'changed' or 'deleted')
     36* `realm`: a string of the affected resource realm (e.g. `'ticket'` or `'wiki'`)
     37* `category`: a string to identify the category of event (e.g. `'created'`, `'changed'` or `'deleted'`)
    3838* `target`: the resource [wiki:TracDev/DataModels model] (e.g. an instance of `Ticket` or `WikiPage`) or `None`
    3939* `time`: the `datetime` when the event happened
     
    4242=== !TicketChangeEvent
    4343* `realm` is 'ticket'.
    44 * Known values for `category` are 'created', 'changed'.
     44* Known values for `category` are `'created'`, `'changed'`, `'attachment added'` and `'attachment deleted'`.
    4545* `target` is an instance of `Ticket`.
    4646* Additional properties: