Uses of Class
com.kingsrook.qqq.backend.core.alerts.NotificationSignal

Packages that use NotificationSignal

Package	Description
com.kingsrook.qqq.backend.core.alerts

Uses of NotificationSignal in com.kingsrook.qqq.backend.core.alerts

Methods in com.kingsrook.qqq.backend.core.alerts that return NotificationSignal

Modifier and Type	Method	Description
NotificationSignal	NotificationSignal.withAttribute(String key, String value)	Add a routing label (not displayed by default).
NotificationSignal	NotificationSignal.withAudience(NotificationAudience audience)	Fluent setter for audience (who it is for; required)
NotificationSignal	NotificationSignal.withBody(String body)	Fluent setter for body (the message, markdown (rendered safely, no raw HTML))
NotificationSignal	NotificationSignal.withCategory(NotificationCategory category)	Fluent setter for category (default SYSTEM)
NotificationSignal	NotificationSignal.withExpireAt(Instant expireAt)	Fluent setter for expireAt (hidden after this time)
NotificationSignal	NotificationSignal.withLink(AlertLink link)	Fluent setter for link (a deep link to where the user acts on it)
NotificationSignal	NotificationSignal.withOccurredAt(Instant occurredAt)	Fluent setter for occurredAt (default: when QAlerts.notify is called)
NotificationSignal	NotificationSignal.withPublishAt(Instant publishAt)	Fluent setter for publishAt (not shown before this time)
NotificationSignal	NotificationSignal.withSeverity(NotificationSeverity severity)	Fluent setter for severity (default INFO)
NotificationSignal	NotificationSignal.withSourceKey(String sourceKey)	Fluent setter for sourceKey (dedup key: a second notify with the same key and audience updates the first)
NotificationSignal	NotificationSignal.withSourceName(String sourceName)	Fluent setter for sourceName (who emitted it: a qbit or app name)
NotificationSignal	NotificationSignal.withSourceRecordId(String sourceRecordId)	Fluent setter for sourceRecordId (the id of the record it is about)
NotificationSignal	NotificationSignal.withSourceTableName(String sourceTableName)	Fluent setter for sourceTableName (the table of the record it is about)
NotificationSignal	NotificationSignal.withSticky(Boolean sticky)	Fluent setter for sticky (a banner until dismissed (meant for CRITICAL))
NotificationSignal	NotificationSignal.withTitle(String title)	Fluent setter for title (the headline, plain text; required)

Methods in com.kingsrook.qqq.backend.core.alerts with parameters of type NotificationSignal

Modifier and Type	Method	Description
default void	AlertSinkInterface.notify(NotificationSignal signal)	Deliver a user notification.
void	LoggingAlertSink.notify(NotificationSignal signal)	Log a user notification (there is no inbox without an implementation).
static void	QAlerts.notify(NotificationSignal signal)	Send a user notification ("tell these people this").
static void	QAlerts.notify(NotificationSignal signal, QBackendTransaction transaction)	Send a user notification after the given transaction commits (or now, when transaction is null and QContext has none).