NotificationLogEntry

final class NotificationLogEntry : Model, @unchecked Sendable

A single notification event that was pushed to one or more users’ notification websockets.

Named NotificationLogEntry rather than Notification to avoid colliding with Foundation.Notification (NotificationCenter’s type)–that name is ambiguous outside this module (e.g. in AppTests), where it silently resolves to the wrong type instead of raising a redeclaration error.

One row is written per fan-out event, not per recipient–who received it is recorded separately in NotificationRecipient, so a broadcast notification (e.g. an .announcement) sent to every user only stores its content once. The row’s id doubles as the notificationID included in the live SocketNotificationData push, letting clients de-dupe a live push against a later fetch of GET /api/v3/notification/log.

Show on GitHub

schema
Declaration
Swift

static let schema: String
Show on GitHub

Properties

id
The entry’s ID. Also sent to socket clients as SocketNotificationData.notificationID.
Declaration
Swift

@NotificationLogEntry .ID var id: UUID? { get set }
Show on GitHub
typeKey
The type of event that happened, stored as SocketNotificationData.NotificationTypeData.databaseKey. See NotificationLogData.init(_:) for how this is decoded back into a NotificationTypeData.
Declaration
Swift

@NotificationLogEntry .Field var typeKey: String { get set }
Show on GitHub
info
A string describing what happened, suitable for adding to a notification alert.
Declaration
Swift

@NotificationLogEntry .Field var info: String { get set }
Show on GitHub
contentID
An ID of an Announcement, Fez, Twarrt, ForumPost, or Event.
Declaration
Swift

@NotificationLogEntry .Field var contentID: String { get set }
Show on GitHub
secondaryContentID
An ID of a related parent object, when one exists. See SocketNotificationData.secondaryContentID.
Declaration
Swift

@NotificationLogEntry .OptionalField var secondaryContentID: String? { get set }
Show on GitHub
createdAt
Timestamp of the model’s creation, set automatically.
Declaration
Swift

@NotificationLogEntry .Timestamp var createdAt: Date? { get set }
Show on GitHub

Initialization

init()
Declaration
Swift

init()
Show on GitHub


                    
                    
                    init(type:info:contentID:secondaryContentID:)

Initializes a new NotificationLogEntry.

Declaration

Swift

init(type: SocketNotificationData.NotificationTypeData, info: String, contentID: String, secondaryContentID: String? = nil)

Show on GitHub