@@ -55,9 +55,10 @@ Available features
55
55
- `Web notifications <#web-notifications >`_
56
56
- `Email notifications <#email-notifications >`_
57
57
- `Configurable email theme <#openwisp_notifications_email_template >`_
58
- - `Definition of notification types <#notification-types >`_
59
- - `Possibility to register new notification types <#registering--unregistering-notification-types >`_
60
- - `Preference for receiving notifications <#notification-preferences >`_
58
+ - `Notification types <#notification-types >`_
59
+ - `Registering new notification types <#registering--unregistering-notification-types >`_
60
+ - `User notification preferences <#notification-preferences >`_
61
+ - `Silencing notifications for specific objects temporarily or permanently <#silencing-notifications-for-specific-objects-temporarily-or-permanently >`_
61
62
- `Automatic cleanup of old notifications <#scheduled-deletion-of-notifications >`_
62
63
- `Configurable host for API endpoints <#openwisp_notifications_host >`_
63
64
@@ -346,6 +347,9 @@ web notifications:
346
347
Notification Widget
347
348
~~~~~~~~~~~~~~~~~~~
348
349
350
+ .. figure :: https://drive.google.com/uc?export=view&id=1EnjVxp_hjJEmUOTGyaqhd5uYCcyWnRaY
351
+ :align: center
352
+
349
353
A javascript widget has been added to make consuming notifications easy for users.
350
354
The notification widget provides following features:
351
355
@@ -355,30 +359,27 @@ The notification widget provides following features:
355
359
- Option to filter unread notifications.
356
360
- Option to mark all notifications as read on a single click.
357
361
358
- .. figure :: https://drive.google.com/uc?export=view&id=1EnjVxp_hjJEmUOTGyaqhd5uYCcyWnRaY
359
- :align: center
360
-
361
362
Notification Toasts
362
363
~~~~~~~~~~~~~~~~~~~
363
364
365
+ .. figure :: https://drive.google.com/uc?export=view&id=1Lm0caDi3_DdiYzKc02DX3Cn2smj6ptWG
366
+ :align: center
367
+
364
368
A notification toast delivers notifications at real-time. This allows
365
369
users to read notifications without even opening the notification widget.
366
370
A notification bell is also played to alert each time a notification is
367
371
displayed through notification toast.
368
372
369
- .. figure :: https://drive.google.com/uc?export=view&id=1Lm0caDi3_DdiYzKc02DX3Cn2smj6ptWG
370
- :align: center
371
-
372
373
Email Notifications
373
374
-------------------
374
375
376
+ .. figure :: https://github.com/openwisp/openwisp-notifications/blob/master/docs/images/email-template.png
377
+
375
378
Along with web notifications *OpenWISP Notification * also sends notifications
376
379
through emails.
377
380
378
381
Following notification email is generated by OpenWISP Notification in *OpenWISP Monitoring *:
379
382
380
- .. figure :: https://github.com/openwisp/openwisp-notifications/blob/master/docs/images/email-template.png
381
-
382
383
Notification Cache
383
384
------------------
384
385
@@ -569,13 +570,13 @@ unregistered in ``ready`` method of your Django application's ``AppConfig``.
569
570
Notification Preferences
570
571
------------------------
571
572
573
+ .. image :: https://github.com/openwisp/openwisp-notifications/blob/master/docs/images/notification-settings.png
574
+
572
575
*openwisp-notifications * allows users to select their preferred way of receiving notifications.
573
576
Users can choose from web or email notifications. These settings have been categorized
574
577
over notification type and organization, therefore allowing users to only receive notifications
575
578
from selected organization or notification type.
576
579
577
- .. image :: https://github.com/openwisp/openwisp-notifications/blob/master/docs/images/notification-settings.png
578
-
579
580
Notification settings are automatically created for all notification types and organizations for all users.
580
581
While superusers can add or delete notification settings for everyone, staff users can only modify their
581
582
preferred ways for receiving notifications. With provided functionality, users can choose to receive both
@@ -586,15 +587,21 @@ by disabling both web and email option for a notification setting.
586
587
then ``email_notification `` or ``web_notification `` option of concerned notification type will be used
587
588
respectively.
588
589
589
- Object Notification Preferences
590
- -------------------------------
591
- *OpenWISP Notifications * allows users to even define notification preferences based on target object.
592
- Users can disable notifications for any object for a desired period of time.
593
- Using the widget on an object's admin form, a user can disable notifications for that object
594
- for a day, week, month or even forever.
590
+ Silencing notifications for specific objects temporarily or permanently
591
+ -----------------------------------------------------------------------
592
+
593
+ .. image :: https://github.com/openwisp/openwisp-notifications/blob/master/docs/images/silence-notifications.png
595
594
596
- **Note **: This feature requires configuring `"OPENWISP_NOTIFICATIONS_IGNORE_ENABLED_ADMIN" <#openwisp-notifications-object-notification-widget >`_
597
- to enable the widget on admin site of required models.
595
+ *OpenWISP Notifications * allows users to silence all notifications generated by
596
+ specific objects they are not interested in for a desired period of time or even permanently,
597
+ while other users will keep receiving notifications normally.
598
+
599
+ Using the widget on an object's admin change form, a user can disable all notifications
600
+ generated by that object for a day, week, month or permanently.
601
+
602
+ **Note **: This feature requires configuring
603
+ `"OPENWISP_NOTIFICATIONS_IGNORE_ENABLED_ADMIN" <#openwisp_notifications_ignore_enabled_admin >`_
604
+ to enable the widget in the admin section of the required models.
598
605
599
606
Scheduled deletion of notifications
600
607
-----------------------------------
@@ -770,17 +777,17 @@ If you want cached notification content to never expire, then set it to ``None``
770
777
Set it to ``0 `` if you don't want to store notification contents in cache at all.
771
778
772
779
``OPENWISP_NOTIFICATIONS_IGNORE_ENABLED_ADMIN ``
773
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
780
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
774
781
775
782
+-----------+-----------+
776
783
| type | ``list `` |
777
784
+-----------+-----------+
778
785
| default | [] |
779
786
+-----------+-----------+
780
787
781
- This setting enables object notification widget on admin site of desired models which
782
- allows user to ` disable notifications for that object . <#object-notification-preferences >`_.
783
- You are required to provide a list of dotted paths to desired model admin .
788
+ This setting enables the widget which allows users to
789
+ ` silence notifications for specific objects temporarily or permanently . <#silencing-notifications-for-specific-objects-temporarily-or-permanently >`_
790
+ in the change page of the specified `` ModelAdmin `` classes .
784
791
785
792
E.g., if you want to enable the widget for objects of ``openwisp_users.models.User ``
786
793
model, then configure the setting as following:
0 commit comments