Source code for kadi.lib.notifications.models

# Copyright 2020 Karlsruhe Institute of Technology
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# See the License for the specific language governing permissions and
# limitations under the License.
from sqlalchemy.dialects.postgresql import JSONB

from kadi.ext.db import db
from kadi.lib.db import UTCDateTime
from kadi.lib.db import composite_index
from kadi.lib.utils import SimpleReprMixin
from kadi.lib.utils import StringEnum
from kadi.lib.utils import utcnow

[docs]class NotificationNames(StringEnum): """String enum containing all possible name values for notifications.""" __values__ = ["task_status"]
[docs]class Notification(SimpleReprMixin, db.Model): """Model to represent notifications."""
[docs] class Meta: """Container to store meta class attributes.""" representation = ["id", "user_id", "name"] """See :class:`.SimpleReprMixin`."""
__tablename__ = "notification" __table_args__ = (composite_index(__tablename__, "user_id", "name"),) id = db.Column(db.Integer, primary_key=True) """The ID of the notification, auto incremented.""" user_id = db.Column(db.Integer, db.ForeignKey(""), nullable=False) """The ID of the :class:`.User` the notification belongs to.""" name = db.Column(db.Text, nullable=False) """The name of the notification.""" data = db.Column(JSONB, nullable=True) """The optional data of the notification, depending on its type.""" created_at = db.Column(UTCDateTime, default=utcnow, nullable=False) """The date and time the notification was created at.""" user = db.relationship("User", back_populates="notifications")
[docs] @classmethod def create(cls, *, user, name, data=None): """Create a new notification and add it to the database session. :param user: The user the notification belongs to. :param name: The name of the notification. :param data: (optional) The data of the notification. :return: The new :class:`Notification` object. """ notification = cls(user=user, name=name, data=data) db.session.add(notification) return notification