Changes between Version 4 and Version 5 of TracDev/Proposals/AdvancedNotification/INotificationFormatter

Timestamp:

Oct 27, 2013, 12:23:19 PM (11 years ago)

Author:

Peter Suter

Comment:

Note change to get_supported_styles()

TracDev/Proposals/AdvancedNotification/INotificationFormatter

@@ -14 +14 @@
 Implementing the interface follows the standard guidelines found in [wiki:TracDev/ComponentArchitecture] and of course [wiki:TracDev/PluginDevelopment].
 
-A simple `styles()` method lists the supported MIME types for a given transport and event realm.
+A simple `get_supported_styles()` method lists the supported MIME types and event realms for a given transport.
 
 The `format()` method formats a notification event. It receives the following parameters:
 * `transport`: The name of the transports that should be used. (See [wiki:INotificationDistributor INotificationDistributor])
-* `style`: The style that should be used. One of those returned by `styles()`.
+* `style`: The style that should be used. One of those returned by `get_supported_styles()`.
 * `event`: A `trac.notification.api.NotificationEvent` instance describing the event about which the recipients should be notified.
 
@@ -37 +37 @@
     # INotificationFormatter methods
     
-    def styles(self, transport, realm):
-        if transport == 'sms' and realm == 'ticket':
-            yield 'text/plain'
+    def get_supported_styles(self, transport):
+        if transport == 'sms':
+            yield ('text/plain', 'ticket')
 
     def format(self, transport, style, event):
@@ -64 +64 @@
    * DONE Dropped the `alternative_style_for()` method. (The distributor can select fallbacks without this.)
    * DONE Dropped the `realm` parameter to the `format()` method. (Use `event.realm` instead.)
+   * DONE Switched from `styles(transport, realm)` to `get_supported_styles(transport)` (See [#Enumerateallstyles below])
 
 == Open questions
@@ -96 +97 @@
 The chosen solution should be simple and easy to implement correctly by plugin authors.
 
+DONE This was implemented in changeset:ac2132adf2c0/psuter
+
 === Quality level?
 Other extension points that enumerate supported cases (e.g. IRepositoryConnector, IHTMLPreviewRenderer, IContentConverter and IDatabaseConnector) also return some kind of ''quality level''. Should something like this be added: