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

Timestamp:

Oct 20, 2013, 10:03:12 AM (11 years ago)

Author:

Peter Suter

Comment:

More questions and possible solutions

TracDev/Proposals/AdvancedNotification/INotificationFormatter

@@ -70 +70 @@
 Maybe `styles()` should be changed to enumerate the supported style / transport / realm combinations as tuples:
 {{{#!python
-    def styles(self):
+    def get_supported_styles(self):
         yield ('text/plain', 'sms', 'ticket')
 }}}
@@ -84 +84 @@
 * Define the interface with ''two methods''. One method with parameters as before; another method without parameters must list all supported styles for any transport or realm.
 * Define the interface with one method, with ''optional parameters''. If the parameters are `None` the method must list all supported styles for any transport or realm.
+* Introduce a mechanism similar to `IAnnouncementProducer.realms()` that enumerates all supported realms. Iterating over all possible realm / transport combinations then gets a complete list of supported styles.
 
-Similary, could some formatters want to support all realms?
+Similary, could some formatters want to support all realms? If not, another possible solution could be to keep the `transport` parameter, but not the `realm` parameter:
+{{{#!python
+    def get_supported_styles(self, transport):
+        if transport == 'sms':
+            yield ('text/plain', 'ticket')
+}}}
+This solves the immediate problem for listing the supported styles per transport. (But does not help if in the future we want to allow the user to selected his preferred style per realm-specific rule.)
 
 The chosen solution should be simple and easy to implement correctly by plugin authors.
+
+=== 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:
+{{{#!python
+    def get_supported_styles(self):
+        yield ('text/plain', 'sms', 'ticket', 8)
+}}}