combo

History

Frédéric Péters b5a8e0cda4 misc: monkeypatch user model with a method to get name id (#30723 )		2019-03-04 13:42:56 +01:00
..
migrations	misc: add last_update_timestamp to pages and cells (#15000 )	2017-02-15 12:22:12 +01:00
templates/newsletters	newsletters: adapt 1.8 compatibility fix for some corbo responses (#22069 )	2018-02-23 21:43:19 +01:00
README	newsletters cell (#9748 )	2016-02-10 22:48:31 +01:00
__init__.py	manager: change "add new cell" to a select box in placeholders divs (#10940 )	2016-05-17 11:21:15 +02:00
forms.py	misc: monkeypatch user model with a method to get name id (#30723 )	2019-03-04 13:42:56 +01:00
models.py	add compatibility with python 3 (#25486 )	2018-07-28 09:55:59 +02:00
urls.py	trivial: mark url patterns as regexes (#16707 )	2017-06-15 13:53:50 +02:00
views.py	newsletters: send user mobile phone when available (#20098 )	2017-12-05 15:03:08 +01:00

README

Combo newsletters cell
======================

This cell is enabled by default.

It expects a webservice returning newsletters and user subscriptions in the
following format:

  [{'id': '1', 'text': 'Democratie locale',
    'transports': [{'id': 'mail', 'text': 'mail'}]},
  {'id': '2', 'text': 'Rencontres de quartiers',
   'transports': [{'id': 'mail', 'text': 'mail'}]},
  {'id': '3', 'text': 'Environnement',
   'transports': [{'id': 'mail', 'text': 'mail'},
                  {'id': 'sms', 'text': 'sms'},
                  {'id': 'rss', 'text': 'rss'}]},
  {'id': '4', 'text': u'Marchés publics',
   'transports': [{'id': 'mail', 'text': 'mail'},
                  {'id': 'rss', 'text': 'rss'}]},
  {'id': '5', 'text': "Offres d'emploi",
   'transports': [{'id': 'mail', 'text': 'mail'},
                  {'id': 'rss', 'text': 'rss'}]},
  {'id': '6', 'text': 'Infos créche',
   'transports': [{'id': 'sms', 'text': 'sms'},
                  {'id': 'rss', 'text': 'rss'}]},
  {'id': '7', 'text': 'Familles',
   'transports': [{'id': 'mail', 'text': 'mail'},
                  {'id': 'sms', 'text': 'sms'}]},
  {'id': '8', 'text': 'Travaux',
   'transports': [{'id': 'mail', 'text': 'mail'},
                  {'id': 'sms', 'text': 'sms'},
                  {'id': 'rss', 'text': 'rss'}]}]


The url to the webservice should be provided in the instatiation form. The
fields **resources_restrictions** and **transports_restrictions** allow to
filter the newsletters by their name and transport means.

**resources_restrictions** field is a comma separated list of newsletters
slugs. For example: __rencontres-de-quartiers,infos-creche__.

In this case only the following newsletters will be exposed in the
subscriptions form:
  [{'id': '2', 'text': 'Rencontres de quartiers',
   'transports': [{'id': 'mail', 'text': 'mail'}]},
   {'id': '6', 'text': 'Infos créche',
   'transports': [{'id': 'sms', 'text': 'sms'},
                  {'id': 'rss', 'text': 'rss'}]}]

**transport_restrictions** field is a comma separated list of transport types.
Example: __sms,rss__

In this case only the newsletters containing one of these transports will be
shown:

  [{'id': '3', 'text': 'Environnement',
   'transports': [{'id': 'mail', 'text': 'mail'},
                  {'id': 'sms', 'text': 'sms'},
                  {'id': 'rss', 'text': 'rss'}]},
  {'id': '4', 'text': u'Marchés publics',
   'transports': [{'id': 'mail', 'text': 'mail'},
                  {'id': 'rss', 'text': 'rss'}]},
  {'id': '5', 'text': "Offres d'emploi",
   'transports': [{'id': 'mail', 'text': 'mail'},
                  {'id': 'rss', 'text': 'rss'}]},
  {'id': '6', 'text': 'Infos créche',
   'transports': [{'id': 'sms', 'text': 'sms'},
                  {'id': 'rss', 'text': 'rss'}]},
  {'id': '7', 'text': 'Familles',
   'transports': [{'id': 'mail', 'text': 'mail'},
                  {'id': 'sms', 'text': 'sms'}]},
  {'id': '8', 'text': 'Travaux',
   'transports': [{'id': 'mail', 'text': 'mail'},
                  {'id': 'sms', 'text': 'sms'},
                  {'id': 'rss', 'text': 'rss'}]}]