App Notification Guide

👀 Overview

App Notifications are processed locally and do not require a third-party service. App Notifications are designed to be processed in the background through automations to reduce the load on the server.

Example

We must first create the Notification object before we create the AppNotification object. Once both objects have been created, we are done! Having a automation that runs notification.automations will handle the rest! For further details on the automations please see the Automations guide.

from django.contrib.contenttypes.models import ContentType
from django.urls import reverse

from django.utils.timezone import now

from django_spire.notification.models import Notification
from django_spire.notification.choices import NotificationTypeChoices

from django_spire.notification.app.models import AppNotification

from foo.models import Foo # import your models here

foo = Foo.objects.get(...)

# Create Notification Object
notification = Notification.objects.create(
    content_type=ContentType.objects.get_for_model(foo),
    object_id=foo.id,
    title='This Notification is About Foo!',
    body='Foo is a very good name when trying to abstract out specific'
         ' logic that is not needed to solve the problem at hand.',
    url=reverse(
        'foo:page:detail',
        kwargs={'pk': foo.id}
    ),
    type=NotificationTypeChoices.APP,
    user=some_user,
    publish_datetime=now()
)

# Create SmsNotification
AppNotification.objects.create(
    notification=notification,
    to_email_address='[email protected]'
)