mirror of
https://gitlab.com/allianceauth/allianceauth.git
synced 2025-12-18 06:45:04 +01:00
Notifications refresh v2 and session caching
This commit is contained in:
BIN
docs/_static/images/features/core/notifications.png
vendored
Normal file
BIN
docs/_static/images/features/core/notifications.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 34 KiB |
@@ -9,5 +9,6 @@ To reduce redundancy and help speed up development we encourage developers to ut
|
||||
esi
|
||||
evelinks
|
||||
eveonline
|
||||
notifications
|
||||
testutils
|
||||
```
|
||||
|
||||
25
docs/development/tech_docu/api/notifications.rst
Normal file
25
docs/development/tech_docu/api/notifications.rst
Normal file
@@ -0,0 +1,25 @@
|
||||
======================
|
||||
notifications
|
||||
======================
|
||||
|
||||
The notifications package has an API for sending notifications.
|
||||
|
||||
Location: ``allianceauth.notifications``
|
||||
|
||||
.. automodule:: allianceauth.notifications.__init__
|
||||
:members: notify
|
||||
:undoc-members:
|
||||
|
||||
models
|
||||
===========
|
||||
|
||||
.. autoclass:: allianceauth.notifications.models.Notification
|
||||
:members: view, set_level, LEVEL_CHOICES
|
||||
:undoc-members:
|
||||
|
||||
managers
|
||||
===========
|
||||
|
||||
.. autoclass:: allianceauth.notifications.managers.NotificationManager
|
||||
:members: notify_user, user_unread_count
|
||||
:undoc-members:
|
||||
@@ -10,4 +10,5 @@ Managing access to applications and services is one of the core functions of **A
|
||||
states
|
||||
groups
|
||||
groupmanagement
|
||||
notifications
|
||||
```
|
||||
|
||||
14
docs/features/core/notifications.md
Normal file
14
docs/features/core/notifications.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# Notifications
|
||||
|
||||
Alliance Auth has a build in notification system. The purpose of the notification system is to provide an easy and quick way to send messages to users of Auth. For example some apps are using it to inform users about results after long running tasks have completed and admins will automatically get notifications about system errors.
|
||||
|
||||
The number of unread notifications is shown to the user in the top menu. And the user can click on the notification count to open the notifications app.
|
||||
|
||||

|
||||
|
||||
## Settings
|
||||
|
||||
The notifications app can be configured through settings.
|
||||
|
||||
- `NOTIFICATIONS_REFRESH_TIME`: The unread count in the top menu is automatically refreshed to keep the user informed about new notifications. This setting allows to set the time between each refresh in seconds. You can also set it to `0` to turn off automatic refreshing. Default: `30`
|
||||
- `NOTIFICATIONS_MAX_PER_USER`: Maximum number of notifications that are stored per user. Older notifications are replaced by newer once. Default: `50`
|
||||
Reference in New Issue
Block a user