Adding Notifications docs - update sample code

Update sample code in the section
Extending Wagtail -> Adding new Task types -> Adding notifications

The previous example did not work because of changes in
`wagtail.admin.mail`

`EmailNotifier` doesn't exist, so we need to import
`EmailNotificationMixin` and `Notifier` instead, and
update `BaseUserApprovalTaskStateEmailNotifier`
accordingly
pull/7538/head
Victor Miti 2021-09-20 14:33:39 +02:00 zatwierdzone przez LB (Ben Johnston)
rodzic bb802509d2
commit f59658c6ca
1 zmienionych plików z 4 dodań i 8 usunięć
docs/extending

Wyświetl plik

@ -244,14 +244,14 @@ As an example, we'll add email notifications for when our new task is started.
# <project>/mail.py
from wagtail.admin.mail import EmailNotifier
from wagtail.admin.mail import EmailNotificationMixin, Notifier
from wagtail.core.models import TaskState
from .models import UserApprovalTaskState
class BaseUserApprovalTaskStateEmailNotifier(EmailNotifier):
"""A base EmailNotifier to send updates for UserApprovalTask events"""
class BaseUserApprovalTaskStateEmailNotifier(EmailNotificationMixin, Notifier):
"""A base notifier to send updates for UserApprovalTask events"""
def __init__(self):
# Allow UserApprovalTaskState and TaskState to send notifications
@ -278,13 +278,9 @@ As an example, we'll add email notifications for when our new task is started.
return recipients
def get_template_base_prefix(self, instance, **kwargs):
# Get the template base prefix for TaskState, so use the ``wagtailadmin/notifications/task_state_`` set of notification templates
return super().get_template_base_prefix(self, instance.task_state_ptr, **kwargs)
class UserApprovalTaskStateSubmissionEmailNotifier(BaseUserApprovalTaskStateEmailNotifier):
"""An EmailNotifier to send updates for UserApprovalTask submission events"""
"""A notifier to send updates for UserApprovalTask submission events"""
notification = 'submitted'