Delphi, C++Builder & .NET Onderdeel van sgcUI

Een Delphi-meldingscomponent met toasts, een inbox en badges

sgcNavigation, onderdeel van sgcUI, brengt een set Delphi-meldingscomponenten naar VCL- en FireMonkey-toepassingen, allemaal aangestuurd door één meldingenmodel.

Toastmeldingen
Inbox gegroepeerd per dag
Badge voor ongelezen berichten
Live push via WebSocket, MQTT of SSE
VCLFireMonkeyC++BuilderWinForms, WPF, Avalonia

Bekijk de code →

Delphi-meldingscomponent in een VCL-toepassing, donker thema: de meldingeninbox met 6 ongelezen berichten, voorkeuren per categorie voor in de app, pop-up, e-mail en push, een activiteitenfeed en een teamoverzicht

De meldingscomponenten

Het model tekent niets en is frameworkneutraal, zodat één model de VCL- en de FireMonkey-weergaven van dezelfde toepassing voedt.

Eén meldingenmodel stuurt toastmeldingen, een meldingeninbox gegroepeerd per dag, een badge voor ongelezen berichten en voorkeuren per categorie aan, en een server kan nieuwe meldingen live pushen via WebSocket, MQTT of server-sent events.

ComponentUnitRol
TsgcNotificationModelsgcNavigation_NotificationNiet-visueel. Houdt de meldingen bij, telt de ongelezen meldingen, markeert ze als gelezen, wijst ze af en slaat ze op als JSON.
TsgcVCLToastManager, TsgcFMXToastManagersgcNavigation_Toast_VCL, sgcNavigation_Toast_FMXNiet-visueel. Toont een toast voor elke nieuwe ongelezen melding van het model, en losstaande toasts vanuit code.
TsgcVCLNotificationInbox, TsgcFMXNotificationInboxsgcNavigation_Inbox_VCL, sgcNavigation_Inbox_FMXEen besturingselement dat de meldingen per dag toont, met de tabbladen All en Unread en een knop Mark all as read.
TsgcNotificationPreferencessgcNavigation_NotifyPrefsNiet-visueel. De kanalen (in de app, pop-up, e-mail, push) die de gebruiker voor elke categorie wil.
TsgcVCLNotificationPrefsEditor, TsgcFMXNotificationPrefsEditorsgcNavigation_NotifyPrefs_VCL, sgcNavigation_NotifyPrefs_FMXEen besturingselement dat de voorkeuren toont als een tabel met selectievakjes, één rij per categorie.
TsgcToolbarBadgeLinksgcToolbar_BadgeLinkNiet-visueel, in sgcToolbar. Toont het aantal ongelezen meldingen van het model als badge van een werkbalk- of lintitem, 99+ boven 99.
TsgcUILiveSource_WebSocket, TsgcUILiveSource_MQTT, TsgcUILiveSource_SSEsgcUICoreWS-brugGeef de JSON-berichten die een server via een sgcWebSockets-verbinding verstuurt door aan het model (Registered-editie).

Toastmeldingen tonen in een Delphi-app

Een toast is een korte kaart die in een hoek van het formulier of het scherm verschijnt, aftelt en zichzelf sluit.

Een toast heeft een ernstpictogram of een afbeelding, een titel, een tekst van maximaal drie regels, een sluitknop en maximaal twee actieknoppen. De toastmanager is een niet-visueel component op het formulier: hij stapelt de toasts, telt ze af, pauzeert ze onder de aanwijzer, laat ze in- en uitfaden en zet de toasts die niet passen in een wachtrij.

  • Position kiest de hoek of de rand, standaard tpsBottomRight, en Anchor van de VCL-manager stapelt de toasts in het formulier of in het werkgebied van het scherm.
  • Duration is standaard 5000 ms, en StickySeverities houdt fouten op het scherm totdat de gebruiker ze sluit.
  • MaxVisible (3) beperkt de toasts op het scherm. De volgende wachten in een wachtrij.
  • Een toast activeert nooit een venster en neemt nooit de focus over, zodat de gebruiker kan blijven typen. Een schermlezer leest elke nieuwe toast voor.
Delphi VCL, een toastmanager en een losstaande 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 heeft TsgcFMXToastManager dezelfde eigenschappen, zonder Anchor. De toasts staan in een overlay binnen het formulier, wat werkt op Windows, macOS, Linux, iOS en Android.

Lees het helponderwerp Toasts

Een meldingeninbox met een badge voor ongelezen berichten

Het model houdt de meldingen van één gebruiker bij. De toasts, de inbox en de badge volgen het zonder verdere code.

Een melding heeft een Id, een titel, een platte tekst, een ernst (info, success, warning of error), een UTC-tijd, een leesstatus, een categorie, de bron die haar heeft aangemaakt en actieknoppen. Add voegt een nieuwe ongelezen melding toe. Post is een upsert op Id, zodat de sleutel van een bestelling, een build of een ticket één melding actueel houdt in plaats van een tweede toe te voegen. MarkRead, MarkAllRead en Dismiss wijzigen de status, en SaveToFile en LoadFromFile bewaren de meldingen tussen sessies als JSON.

  • Inbox: de meldingen gegroepeerd per dag, alle of alleen ongelezen, met Mark all as read.
  • Badge voor ongelezen berichten: TsgcToolbarBadgeLink toont het aantal ongelezen meldingen op een werkbalkknop, of in de Registered-editie op een lintknop.
  • Voorkeuren: één rij per categorie en één kolom per kanaal. Als je het pop-upkanaal van een categorie uitschakelt, verschijnen de toasts ervan niet meer, en de inbox toont ze nog steeds.
  • Acties: een klik op een actieknop, in een toast of in de inbox, activeert OnAction van het model met de id van de actie.
Delphi VCL, het hele meldingencentrum
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;

Wijzigingen tussen BeginUpdate en EndUpdate bereiken de weergaven één keer, zodat de toast de voltooide melding met haar knoppen toont. Het model wordt vanuit de hoofdthread gebruikt.

Lees het helponderwerp Notifications

Meldingen vanaf een server pushen via WebSocket, MQTT of SSE

Een server houdt de meldingen van een gebruiker actueel met live berichten, één JSON-object per bericht.

ApplyMessage past een bericht toe op het model: add, update, remove, read, unread of snapshot. De toasts, de inbox en de badge volgen het model, dus een bericht van de server verschijnt op het scherm zonder verdere code. ApplyMessage veroorzaakt nooit een uitzondering. Het geeft False terug en laat het model ongewijzigd wanneer een bericht er niet voor bedoeld is.

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"}

De live bronnen van de sgcUICoreWS-brug nemen de berichten van een sgcWebSockets-client over en geven ze door aan het model: TsgcUILiveSource_WebSocket voor een TsgcWebSocketClient, TsgcUILiveSource_MQTT voor een TsgcWSPClient_MQTT en TsgcUILiveSource_SSE voor de server-sent events van een TsgcHTTP1Client. Berichten die in een socketthread binnenkomen, worden in een wachtrij gezet en in de hoofdthread toegepast.

Delphi, meldingen vanuit een WebSocket-kanaal
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;
  • De bron verbindt nooit, abonneert zich nooit en verstuurt nooit iets. De URL, de inloggegevens, TLS en het opnieuw verbinden zijn aan de client.
  • De brug werkt alleen inkomend. Wanneer de gebruiker een melding leest of afwijst, verwerk je OnNotification en OnAction van het model en verstuur je je eigen frame via dezelfde client.

Live berichten en de live bronnen maken deel uit van de Registered-editie, en de live bronnen hebben sgcWebSockets nodig. Zonder server roept de toepassing Add en Post van het model aan.

Lees het helponderwerp Notification Live Messages

VCL, FireMonkey, C++Builder en .NET

Delphi 7 tot Delphi 13 met VCL, FireMonkey vanaf Delphi XE6, C++Builder, en .NET WinForms, WPF en Avalonia.

De Realtime-demo voor Delphi FireMonkey in het donkere thema, met de meldingeninbox en de badge voor ongelezen berichten

Eén model, elke front-end

  • VCL: TsgcVCLToastManager, TsgcVCLNotificationInbox en TsgcVCLNotificationPrefsEditor
  • FireMonkey: TsgcFMXToastManager, TsgcFMXNotificationInbox en TsgcFMXNotificationPrefsEditor
  • C++Builder: dezelfde componenten, met C++-voorbeelden in de help
  • .NET: TsgcWinFormsToastManager, TsgcWpfToastManager en TsgcAvaloniaToastManager, met de inbox en de voorkeureneditor

De Realtime-demo van de sgcUI-suite bouwt een operatieconsole met een bel waarvan de badge het aantal ongelezen berichten is, en de meldingeninbox boven de voorkeuren, in VCL, FireMonkey, C++Builder en .NET. Zie het Realtime UI-pack.

Community en Registered

De meldingscomponenten volgen de editie van hun product, sgcNavigation, en de badgekoppeling volgt sgcToolbar.

OnderdeelProduct.NET CommunityRegistered
Meldingenmodel, toasts, inbox en voorkeurensgcNavigationJaJa
Badgekoppeling met een werkbalksgcToolbarJaJa
Badgekoppeling met een lintsgcToolbarNoJa
Live meldingsberichtensgcNavigationNoJa
Live bronnen via WebSocket, MQTT en SSE (vereist sgcWebSockets)sgcUICoreNoJa

In Delphi en C++Builder worden de meldingscomponenten geleverd met sgcUI Standard, Professional, Enterprise, All-Access en de proefversie, en met los verkochte sgcNavigation en sgcToolbar. De gratis .NET Community-packages bevatten ze ook. De Delphi Community-editie bevat alleen sgcGrid. Zie de sgcUI-prijzen.

Veelgestelde vragen

Plaats een TsgcVCLToastManager op het formulier, of een TsgcFMXToastManager in FireMonkey, en roep Show aan met een titel, een tekst en een ernst. De toast verschijnt in de hoek die je kiest, telt standaard vijf seconden af, pauzeert zolang de aanwijzer erboven staat en neemt nooit de focus over. Met het ingestelde Model toont de manager ook een toast voor elke nieuwe ongelezen melding.

Maak een TsgcNotificationModel aan en stel het in als Model van een TsgcVCLNotificationInbox, die de meldingen per dag toont met de tabbladen All en Unread en een knop Mark all as read. Stel het model daarna in als Source van een TsgcToolbarBadgeLink met een werkbalk als Target: het aantal ongelezen meldingen verschijnt op de knop, als 99+ boven 99.

Ja, in de Registered-editie. De server verstuurt per wijziging één JSON-bericht en ApplyMessage past het toe op het model. De live bronnen van de sgcUICoreWS-brug lezen die berichten uit een WebSocket-, MQTT- of server-sent events-client van sgcWebSockets en passen ze in de hoofdthread toe, zodat de toasts, de inbox en de badge zonder verdere code worden bijgewerkt.

Ja. TsgcFMXToastManager, TsgcFMXNotificationInbox en TsgcFMXNotificationPrefsEditor werken vanaf Delphi XE6. De FireMonkey-toasts staan in een overlay binnen het formulier, op Windows, macOS, Linux, iOS en Android. Het model is frameworkneutraal, dus hetzelfde TsgcNotificationModel voedt VCL- en FireMonkey-weergaven.

Ja. TsgcNotificationPreferences bevat de kanalen die de gebruiker voor elke categorie wil: in de app, pop-up, e-mail en push. De voorkeureneditor toont ze als een tabel met selectievakjes. Een toastmanager met ingestelde Preferences toont geen toast voor een categorie waarvan het pop-upkanaal uit staat, en de inbox toont die meldingen nog steeds.

Ja, wanneer je ze opslaat. SaveToFile en LoadFromFile van het model bewaren de meldingen tussen sessies als JSON-bestand, en MaxCount (standaard 500) begrenst het model, waarbij de oudste gelezen meldingen als eerste worden verwijderd.

De gratis .NET Community-packages bevatten het model, de toasts, de inbox en de voorkeuren. De Delphi Community-editie bevat alleen sgcGrid, dus in Delphi en C++Builder worden de meldingscomponenten geleverd met sgcNavigation, los verkocht of in sgcUI Standard en hoger. De All-Access-proefversie bevat elk sgcUI-product voor evaluatie.

De beste deal: All-AccessElk eSeGeCe-product, inclusief Premium-ondersteuning, vanaf €1,059 per jaar.
Bekijk de All-Access-prijzen

Voeg meldingen toe aan je Delphi-toepassing

Download de sgcUI-proefversie en probeer de toasts, de inbox en de badge uit in je eigen IDE.