Delphi, C++Builder & .NET Teil von sgcUI

Eine Delphi-Benachrichtigungskomponente mit Toasts, Posteingang und Badges

sgcNavigation, Teil von sgcUI, bringt einen Delphi-Komponentensatz für Benachrichtigungen in VCL- und FireMonkey-Anwendungen, alles gesteuert von einem Benachrichtigungsmodell.

Toast-Benachrichtigungen
Nach Tagen gruppierter Posteingang
Badge für Ungelesenes
Live-Push über WebSocket, MQTT oder SSE
VCLFireMonkeyC++BuilderWinForms, WPF, Avalonia

Den Code ansehen →

Delphi-Benachrichtigungskomponente in einer VCL-Anwendung, dunkles Theme: der Benachrichtigungs-Posteingang mit 6 Ungelesenen, Einstellungen pro Kategorie für In-App, Pop-up, E-Mail und Push, ein Aktivitäts-Feed und eine Teamliste

Die Benachrichtigungskomponenten

Das Modell zeichnet nichts und ist frameworkneutral, sodass ein Modell die VCL- und die FireMonkey-Ansichten derselben Anwendung speist.

Ein Benachrichtigungsmodell steuert Toast-Benachrichtigungen, einen nach Tagen gruppierten Benachrichtigungs-Posteingang, ein Badge für Ungelesenes und Einstellungen pro Kategorie, und ein Server kann neue Benachrichtigungen live über WebSocket, MQTT oder Server-Sent Events pushen.

KomponenteUnitRolle
TsgcNotificationModelsgcNavigation_NotificationNicht visuell. Verwaltet die Benachrichtigungen, zählt die ungelesenen, markiert sie als gelesen, verwirft sie und speichert sie als JSON.
TsgcVCLToastManager, TsgcFMXToastManagersgcNavigation_Toast_VCL, sgcNavigation_Toast_FMXNicht visuell. Zeigt einen Toast für jede neue ungelesene Benachrichtigung des Modells und eigenständige Toasts aus dem Code.
TsgcVCLNotificationInbox, TsgcFMXNotificationInboxsgcNavigation_Inbox_VCL, sgcNavigation_Inbox_FMXEin Control, das die Benachrichtigungen nach Tagen auflistet, mit den Tabs Alle und Ungelesen und einer Schaltfläche Alle als gelesen markieren.
TsgcNotificationPreferencessgcNavigation_NotifyPrefsNicht visuell. Die Kanäle (In-App, Pop-up, E-Mail, Push), die der Benutzer für jede Kategorie möchte.
TsgcVCLNotificationPrefsEditor, TsgcFMXNotificationPrefsEditorsgcNavigation_NotifyPrefs_VCL, sgcNavigation_NotifyPrefs_FMXEin Control, das die Einstellungen als Tabelle mit Kontrollkästchen zeigt, eine Zeile pro Kategorie.
TsgcToolbarBadgeLinksgcToolbar_BadgeLinkNicht visuell, in sgcToolbar. Zeigt die Zahl der Ungelesenen des Modells als Badge eines Symbolleisten- oder Ribbon-Elements, ab 99 als 99+.
TsgcUILiveSource_WebSocket, TsgcUILiveSource_MQTT, TsgcUILiveSource_SSEBrücke sgcUICoreWSÜbergibt die JSON-Nachrichten, die ein Server über eine sgcWebSockets-Verbindung sendet, an das Modell (Edition Registered).

Toast-Benachrichtigungen in einer Delphi-App anzeigen

Ein Toast ist eine kurze Karte, die an einer Ecke des Formulars oder des Bildschirms erscheint, herunterzählt und sich von selbst schließt.

Ein Toast hat ein Schweregrad-Symbol oder ein Bild, einen Titel, einen Text von bis zu drei Zeilen, eine Schließen-Schaltfläche und bis zu zwei Aktionsschaltflächen. Der Toast-Manager ist eine nicht visuelle Komponente auf dem Formular: Er stapelt die Toasts, zählt sie herunter, pausiert sie unter dem Mauszeiger, blendet sie ein und aus und reiht die ein, die nicht passen.

  • Position wählt die Ecke oder den Rand, standardmäßig tpsBottomRight, und Anchor des VCL-Managers stapelt die Toasts im Formular oder im Arbeitsbereich des Bildschirms.
  • Duration beträgt standardmäßig 5000 ms, und StickySeverities hält Fehler auf dem Bildschirm, bis der Benutzer sie schließt.
  • MaxVisible (3) begrenzt die Toasts auf dem Bildschirm; die nächsten warten in einer Warteschlange.
  • Ein Toast aktiviert nie ein Fenster und nimmt nie den Fokus, sodass der Benutzer weitertippen kann. Ein Screenreader liest jeden neuen Toast vor.
Delphi VCL, ein Toast-Manager und ein eigenständiger Toast
uses
  Classes, SysUtils, Forms,
  sgcNavigation_Notification, sgcNavigation_Toast, sgcNavigation_Toast_VCL;

procedure TMainForm.FormCreate(Sender: TObject);
begin
  FToasts := TsgcVCLToastManager.Create(Self);
  // the bottom right corner of the form, two toasts at a time
  FToasts.Anchor := tanForm;
  FToasts.Position := tpsBottomRight;
  FToasts.MaxVisible := 2;
  // warnings and errors stay until the user closes them
  FToasts.StickySeverities := [nsvWarning, nsvError];
end;

procedure TMainForm.ExportFinished(aRows: Integer);
begin
  FToasts.Show('Export finished', IntToStr(aRows) + ' rows written.',
    nsvSuccess);
end;

In FireMonkey hat TsgcFMXToastManager dieselben Eigenschaften ohne Anchor. Die Toasts liegen in einem Overlay innerhalb des Formulars, das unter Windows, macOS, Linux, iOS und Android funktioniert.

Das Hilfethema Toasts lesen

Ein Benachrichtigungs-Posteingang mit Badge für Ungelesenes

Das Modell verwaltet die Benachrichtigungen eines Benutzers; die Toasts, der Posteingang und das Badge folgen ihm ohne weiteren Code.

Eine Benachrichtigung hat eine Id, einen Titel, einen Klartext-Text, einen Schweregrad (info, success, warning oder error), eine UTC-Zeit, einen Lesestatus, eine Kategorie, die Quelle, die sie ausgelöst hat, und Aktionsschaltflächen. Add fügt eine neue ungelesene Benachrichtigung hinzu. Post ist ein Upsert nach Id, sodass der Schlüssel einer Bestellung, eines Builds oder eines Tickets eine Benachrichtigung aktuell hält, statt eine zweite hinzuzufügen. MarkRead, MarkAllRead und Dismiss ändern den Status, und SaveToFile und LoadFromFile bewahren die Benachrichtigungen zwischen Sitzungen als JSON auf.

  • Posteingang: die nach Tagen gruppierten Benachrichtigungen, alle oder nur ungelesene, mit Alle als gelesen markieren.
  • Badge für Ungelesenes: TsgcToolbarBadgeLink zeigt die Zahl der Ungelesenen auf einer Symbolleisten-Schaltfläche an, in der Edition Registered auch auf einer Ribbon-Schaltfläche.
  • Einstellungen: eine Zeile pro Kategorie und eine Spalte pro Kanal. Wenn du den Pop-up-Kanal einer Kategorie ausschaltest, erscheinen ihre Toasts nicht mehr, und der Posteingang listet sie weiterhin auf.
  • Aktionen: Ein Klick auf eine Aktionsschaltfläche, in einem Toast oder im Posteingang, löst OnAction des Modells mit der Id der Aktion aus.
Delphi VCL, das gesamte Benachrichtigungscenter
uses
  Classes, SysUtils, Controls, Forms,
  sgcNavigation_Notification, sgcNavigation_NotifyPrefs,
  sgcNavigation_Toast_VCL, sgcNavigation_Inbox_VCL,
  sgcToolbar_VCL, sgcToolbar_BadgeLink;

procedure TMainForm.SetupNotifications(aToolbar: TsgcVCLToolbar);
var
  vFile: string;
begin
  // the notifications of the user, kept between sessions
  FModel := TsgcNotificationModel.Create(Self);
  vFile := ExtractFilePath(Application.ExeName) + 'notifications.json';
  if FileExists(vFile) then
    FModel.LoadFromFile(vFile);
  FModel.OnAction := ModelAction;

  // orders pop up, news only go to the inbox
  FPrefs := TsgcNotificationPreferences.Create(Self);
  FPrefs.Categories.Add('orders', 'Orders');
  FPrefs.Categories.Add('news', 'News').Defaults := [nchInApp];

  // a toast for every new unread notification its category allows
  FToasts := TsgcVCLToastManager.Create(Self);
  FToasts.Preferences := FPrefs;
  FToasts.Model := FModel;

  // every notification, newest first, under a header per day
  FInbox := TsgcVCLNotificationInbox.Create(Self);
  FInbox.Parent := Self;
  FInbox.Align := alRight;
  FInbox.Width := 360;
  FInbox.Model := FModel;

  // the unread count as the badge of the first toolbar button
  FBadge := TsgcToolbarBadgeLink.Create(Self);
  FBadge.Source := FModel;
  FBadge.Target := aToolbar;
  FBadge.ItemIndex := 0;
end;

procedure TMainForm.OrderShipped(const aOrderId: string);
var
  oItem: TsgcNotificationItem;
begin
  FModel.BeginUpdate;
  try
    // an upsert: the same id updates the notification
    oItem := FModel.Post('order-' + aOrderId, 'Order ' + aOrderId +
      ' shipped', 'The parcel left the warehouse.', nsvSuccess, 'orders');
    if oItem.Actions.IndexOf('track') < 0 then
      oItem.Actions.Add('track', 'Track');
  finally
    FModel.EndUpdate;
  end;
end;

Änderungen zwischen BeginUpdate und EndUpdate erreichen die Ansichten nur einmal, sodass der Toast die fertige Benachrichtigung mit ihren Schaltflächen zeigt. Das Modell wird aus dem Hauptthread verwendet.

Das Hilfethema Notifications lesen

Push-Benachrichtigungen von einem Server über WebSocket, MQTT oder SSE

Ein Server hält die Benachrichtigungen eines Benutzers mit Live-Nachrichten aktuell, ein JSON-Objekt pro Nachricht.

ApplyMessage wendet eine Nachricht auf das Modell an: add, update, remove, read, unread oder snapshot. Die Toasts, der Posteingang und das Badge folgen dem Modell, sodass eine Nachricht vom Server ohne weiteren Code auf dem Bildschirm erscheint. ApplyMessage löst nie eine Exception aus; es gibt False zurück und lässt das Modell unverändert, wenn eine Nachricht nicht für es bestimmt ist.

messages.json
{"type":"notification","op":"add","notification":{"id":"n2","title":"Build 812 passed","severity":"success","group":"ci"}}
{"type":"notification","op":"update","notification":{"id":"n2","body":"All 1,204 tests passed"}}
{"type":"notification","op":"read","ids":["n1","n2"]}
{"type":"notification","op":"remove","id":"n1"}

Die Live-Quellen der Brücke sgcUICoreWS nehmen die Nachrichten eines sgcWebSockets-Clients entgegen und übergeben sie an das Modell: TsgcUILiveSource_WebSocket für einen TsgcWebSocketClient, TsgcUILiveSource_MQTT für einen TsgcWSPClient_MQTT und TsgcUILiveSource_SSE für die Server-Sent Events eines TsgcHTTP1Client. Nachrichten, die in einem Socket-Thread eintreffen, werden in eine Warteschlange gestellt und im Hauptthread angewendet.

Delphi, Benachrichtigungen aus einem WebSocket-Kanal
uses
  Classes, SysUtils,
  sgcWebSocket, sgcUICoreWS_Live, sgcUICoreWS_Live_WebSocket,
  sgcNavigation_Notification;

function BindNotifications(aOwner: TComponent; aClient: TsgcWebSocketClient;
  aModel: TsgcNotificationModel): TsgcUILiveSource_WebSocket;
var
  oBinding: TsgcUILiveBinding;
begin
  Result := TsgcUILiveSource_WebSocket.Create(aOwner);
  Result.Client := aClient;
  oBinding := Result.Bindings.Add;
  oBinding.Target := aModel;
  // only the frames of the alerts channel, the live message is in "data":
  // {"channel":"alerts","data":{"type":"notification","op":"add",...}}
  oBinding.FilterPath := 'channel';
  oBinding.FilterValue := 'alerts';
  oBinding.MessagePath := 'data';
end;
  • Die Quelle verbindet sich nie, abonniert nie und sendet nie. Die URL, die Zugangsdaten, TLS und die Wiederverbindung gehören zum Client.
  • Die Brücke arbeitet nur eingehend. Wenn der Benutzer eine Benachrichtigung liest oder verwirft, behandle OnNotification und OnAction des Modells und sende deinen eigenen Frame über denselben Client.

Live-Nachrichten und die Live-Quellen gehören zur Edition Registered, und die Live-Quellen benötigen sgcWebSockets. Ohne Server ruft die Anwendung Add und Post des Modells auf.

Das Hilfethema Notification Live Messages lesen

VCL, FireMonkey, C++Builder und .NET

Delphi 7 bis Delphi 13 mit VCL, FireMonkey ab Delphi XE6, C++Builder sowie .NET WinForms, WPF und Avalonia.

Die Demo Realtime für Delphi FireMonkey im dunklen Theme, mit dem Benachrichtigungs-Posteingang und dem Badge für Ungelesenes

Ein Modell, jedes Frontend

  • VCL: TsgcVCLToastManager, TsgcVCLNotificationInbox und TsgcVCLNotificationPrefsEditor
  • FireMonkey: TsgcFMXToastManager, TsgcFMXNotificationInbox und TsgcFMXNotificationPrefsEditor
  • C++Builder: dieselben Komponenten, mit C++-Beispielen in der Hilfe
  • .NET: TsgcWinFormsToastManager, TsgcWpfToastManager und TsgcAvaloniaToastManager, mit dem Posteingang und dem Einstellungs-Editor

Die Demo Realtime der sgcUI-Suite baut eine Betriebskonsole mit einer Glocke, deren Badge die Zahl der Ungelesenen ist, und dem Benachrichtigungs-Posteingang über den Einstellungen, in VCL, FireMonkey, C++Builder und .NET. Siehe das Realtime-UI-Paket.

Community und Registered

Die Benachrichtigungskomponenten folgen der Edition ihres Produkts, sgcNavigation, und der Badge-Link folgt sgcToolbar.

BausteinProdukt.NET CommunityRegistered
Benachrichtigungsmodell, Toasts, Posteingang und EinstellungensgcNavigationJaJa
Badge-Link mit einer SymbolleistesgcToolbarJaJa
Badge-Link mit einem RibbonsgcToolbarNoJa
Live-BenachrichtigungsnachrichtensgcNavigationNoJa
Live-Quellen über WebSocket, MQTT und SSE (benötigt sgcWebSockets)sgcUICoreNoJa

In Delphi und C++Builder sind die Benachrichtigungskomponenten in sgcUI Standard, Professional, Enterprise, All-Access und in der Testversion enthalten sowie bei einzeln verkauftem sgcNavigation und sgcToolbar. Die kostenlosen .NET-Community-Packages enthalten sie ebenfalls. Die Delphi-Community-Edition liefert nur sgcGrid. Siehe die sgcUI-Preise.

Häufig gestellte Fragen

Lege einen TsgcVCLToastManager auf dem Formular ab, oder in FireMonkey einen TsgcFMXToastManager, und rufe Show mit einem Titel, einem Text und einem Schweregrad auf. Der Toast erscheint an der gewählten Ecke, zählt standardmäßig fünf Sekunden herunter, pausiert, solange der Mauszeiger darüber steht, und nimmt nie den Fokus. Ist sein Model gesetzt, zeigt der Manager außerdem für jede neue ungelesene Benachrichtigung einen Toast.

Erstelle ein TsgcNotificationModel und setze es als Model eines TsgcVCLNotificationInbox, der die Benachrichtigungen nach Tagen auflistet, mit den Tabs Alle und Ungelesen und einer Schaltfläche Alle als gelesen markieren. Setze das Modell dann als Source eines TsgcToolbarBadgeLink mit einer Symbolleiste als Target: Die Zahl der Ungelesenen erscheint auf der Schaltfläche, ab 99 als 99+.

Ja, in der Edition Registered. Der Server sendet pro Änderung eine JSON-Nachricht, und ApplyMessage wendet sie auf das Modell an. Die Live-Quellen der Brücke sgcUICoreWS lesen diese Nachrichten aus einem WebSocket-, MQTT- oder Server-Sent-Events-Client von sgcWebSockets und wenden sie im Hauptthread an, sodass die Toasts, der Posteingang und das Badge ohne weiteren Code aktualisiert werden.

Ja. TsgcFMXToastManager, TsgcFMXNotificationInbox und TsgcFMXNotificationPrefsEditor funktionieren ab Delphi XE6. Die FireMonkey-Toasts liegen in einem Overlay innerhalb des Formulars, unter Windows, macOS, Linux, iOS und Android. Das Modell ist frameworkneutral, sodass dasselbe TsgcNotificationModel VCL- und FireMonkey-Ansichten speist.

Ja. TsgcNotificationPreferences enthält die Kanäle, die der Benutzer für jede Kategorie möchte: In-App, Pop-up, E-Mail und Push. Der Einstellungs-Editor zeigt sie als Tabelle mit Kontrollkästchen. Ein Toast-Manager mit gesetztem Preferences zeigt keinen Toast für eine Kategorie, deren Pop-up-Kanal ausgeschaltet ist, und der Posteingang listet diese Benachrichtigungen weiterhin auf.

Ja, wenn du sie speicherst. SaveToFile und LoadFromFile des Modells bewahren die Benachrichtigungen zwischen Sitzungen als JSON-Datei auf, und MaxCount (standardmäßig 500) begrenzt das Modell, wobei die ältesten gelesenen Benachrichtigungen zuerst verworfen werden.

Die kostenlosen .NET-Community-Packages enthalten das Modell, die Toasts, den Posteingang und die Einstellungen. Die Delphi-Community-Edition liefert nur sgcGrid, daher sind die Benachrichtigungskomponenten in Delphi und C++Builder in sgcNavigation enthalten, einzeln oder in sgcUI Standard und höher verkauft. Die All-Access-Testversion enthält jedes sgcUI-Produkt zur Evaluierung.

Bestes Preis-Leistungs-Verhältnis: All-AccessAlle eSeGeCe-Produkte, inklusive Premium-Support, ab €1,059 pro Jahr.
All-Access-Preise ansehen

Füge deiner Delphi-Anwendung Benachrichtigungen hinzu

Lade die sgcUI-Testversion herunter und probiere die Toasts, den Posteingang und das Badge in deiner eigenen IDE aus.