Delphi, C++Builder & .NET Fait partie de sgcUI

Un composant de notification Delphi avec toasts, boîte de réception et badges

sgcNavigation, qui fait partie de sgcUI, apporte un jeu de composants de notification Delphi aux applications VCL et FireMonkey, le tout piloté par un seul modèle de notification.

Notifications toast
Boîte de réception groupée par jour
Badge de non-lus
Push en direct par WebSocket, MQTT ou SSE
VCLFireMonkeyC++BuilderWinForms, WPF, Avalonia

Voir le code →

Composant de notification Delphi dans une application VCL, thème sombre : la boîte de réception de notifications avec 6 non-lus, des préférences par catégorie pour l'application, la fenêtre contextuelle, l'e-mail et le push, un fil d'activité et une liste d'équipe

Les composants de notification

Le modèle ne dessine rien et est indépendant du framework, si bien qu'un seul modèle alimente les vues VCL et FireMonkey d'une même application.

Un seul modèle de notification pilote les notifications toast, une boîte de réception de notifications groupées par jour, un badge de non-lus et des préférences par catégorie, et un serveur peut pousser de nouvelles notifications en direct par WebSocket, MQTT ou événements envoyés par le serveur.

ComposantUnitéRôle
TsgcNotificationModelsgcNavigation_NotificationNon visuel. Conserve les notifications, compte les non-lues, les marque comme lues, les ferme et les enregistre en JSON.
TsgcVCLToastManager, TsgcFMXToastManagersgcNavigation_Toast_VCL, sgcNavigation_Toast_FMXNon visuel. Affiche un toast pour chaque nouvelle notification non lue du modèle, et des toasts autonomes depuis le code.
TsgcVCLNotificationInbox, TsgcFMXNotificationInboxsgcNavigation_Inbox_VCL, sgcNavigation_Inbox_FMXUn contrôle qui liste les notifications par jour, avec des onglets Toutes et Non lues et un bouton Tout marquer comme lu.
TsgcNotificationPreferencessgcNavigation_NotifyPrefsNon visuel. Les canaux (dans l'application, fenêtre contextuelle, e-mail, push) que l'utilisateur souhaite pour chaque catégorie.
TsgcVCLNotificationPrefsEditor, TsgcFMXNotificationPrefsEditorsgcNavigation_NotifyPrefs_VCL, sgcNavigation_NotifyPrefs_FMXUn contrôle qui affiche les préférences sous forme de tableau de cases à cocher, une ligne par catégorie.
TsgcToolbarBadgeLinksgcToolbar_BadgeLinkNon visuel, dans sgcToolbar. Affiche le nombre de non-lus du modèle comme badge d'un élément de barre d'outils ou de ruban, 99+ au-delà de 99.
TsgcUILiveSource_WebSocket, TsgcUILiveSource_MQTT, TsgcUILiveSource_SSEPasserelle sgcUICoreWSTransmet au modèle les messages JSON qu'un serveur envoie via une connexion sgcWebSockets (édition Registered).

Afficher des notifications toast dans une application Delphi

Un toast est une courte carte qui apparaît dans un coin de la fiche ou de l'écran, décompte et se ferme tout seul.

Un toast a un glyphe de gravité ou une image, un titre, un corps de trois lignes au plus, un bouton de fermeture et jusqu'à deux boutons d'action. Le gestionnaire de toasts est un composant non visuel sur la fiche : il empile les toasts, les décompte, les met en pause sous le pointeur, les fait apparaître et disparaître en fondu et met en file d'attente ceux qui ne tiennent pas.

  • Position choisit le coin ou le bord, tpsBottomRight par défaut, et Anchor du gestionnaire VCL empile les toasts dans la fiche ou dans la zone de travail de l'écran.
  • Duration vaut 5000 ms par défaut, et StickySeverities garde les erreurs à l'écran jusqu'à ce que l'utilisateur les ferme.
  • MaxVisible (3) limite les toasts à l'écran ; les suivants attendent dans une file.
  • Un toast n'active jamais une fenêtre et ne prend jamais le focus, si bien que l'utilisateur continue de taper. Un lecteur d'écran lit chaque nouveau toast.
Delphi VCL, un gestionnaire de toasts et un toast autonome
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;

Dans FireMonkey, TsgcFMXToastManager a les mêmes propriétés sans Anchor. Les toasts vivent dans une superposition à l'intérieur de la fiche, ce qui fonctionne sous Windows, macOS, Linux, iOS et Android.

Lire la rubrique d'aide Toasts

Une boîte de réception de notifications avec badge de non-lus

Le modèle conserve les notifications d'un utilisateur ; les toasts, la boîte de réception et le badge le suivent sans autre code.

Une notification a un Id, un titre, un corps en texte brut, une gravité (info, succès, avertissement ou erreur), une heure UTC, un état de lecture, une catégorie, la source qui l'a émise et des boutons d'action. Add ajoute une nouvelle notification non lue. Post est un upsert par Id, si bien que la clé d'une commande, d'un build ou d'un ticket garde une notification à jour au lieu d'en ajouter une seconde. MarkRead, MarkAllRead et Dismiss changent l'état, et SaveToFile et LoadFromFile conservent les notifications entre les sessions en JSON.

  • Boîte de réception : les notifications groupées par jour, toutes ou seulement non lues, avec Tout marquer comme lu.
  • Badge de non-lus : TsgcToolbarBadgeLink affiche le nombre de non-lus sur un bouton de barre d'outils, ou sur un bouton de ruban dans l'édition Registered.
  • Préférences : une ligne par catégorie et une colonne par canal. Désactiver le canal de fenêtre contextuelle d'une catégorie arrête ses toasts, et la boîte de réception les liste toujours.
  • Actions : un clic sur un bouton d'action, dans un toast ou dans la boîte de réception, déclenche OnAction du modèle avec l'identifiant de l'action.
Delphi VCL, tout le centre de notifications
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;

Les changements effectués entre BeginUpdate et EndUpdate n'atteignent les vues qu'une seule fois, si bien que le toast affiche la notification terminée avec ses boutons. Le modèle s'utilise depuis le thread principal.

Lire la rubrique d'aide Notifications

Notifications push depuis un serveur par WebSocket, MQTT ou SSE

Un serveur garde à jour les notifications d'un utilisateur avec des messages en direct, un objet JSON par message.

ApplyMessage applique un message au modèle : add, update, remove, read, unread ou snapshot. Les toasts, la boîte de réception et le badge suivent le modèle, si bien qu'un message du serveur s'affiche à l'écran sans autre code. ApplyMessage ne lève jamais d'exception ; il renvoie False et laisse le modèle inchangé quand un message ne le concerne pas.

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

Les sources en direct de la passerelle sgcUICoreWS prennent les messages d'un client sgcWebSockets et les transmettent au modèle : TsgcUILiveSource_WebSocket pour un TsgcWebSocketClient, TsgcUILiveSource_MQTT pour un TsgcWSPClient_MQTT et TsgcUILiveSource_SSE pour les événements envoyés par le serveur d'un TsgcHTTP1Client. Les messages qui arrivent dans un thread de socket sont mis en file d'attente et appliqués dans le thread principal.

Delphi, notifications depuis un canal WebSocket
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;
  • La source ne se connecte, ne s'abonne et n'envoie jamais. L'URL, les identifiants, TLS et la reconnexion relèvent du client.
  • La passerelle est en entrée uniquement. Quand l'utilisateur lit ou ferme une notification, gère OnNotification et OnAction du modèle et envoie ta propre trame via le même client.

Les messages en direct et les sources en direct font partie de l'édition Registered, et les sources en direct nécessitent sgcWebSockets. Sans serveur, l'application appelle Add et Post du modèle.

Lire la rubrique d'aide Messages de notification en direct

VCL, FireMonkey, C++Builder et .NET

Delphi 7 à Delphi 13 avec VCL, FireMonkey à partir de Delphi XE6, C++Builder, et .NET WinForms, WPF et Avalonia.

La démo Realtime pour Delphi FireMonkey dans le thème sombre, avec la boîte de réception de notifications et le badge de non-lus

Un seul modèle, chaque interface

  • VCL : TsgcVCLToastManager, TsgcVCLNotificationInbox et TsgcVCLNotificationPrefsEditor
  • FireMonkey : TsgcFMXToastManager, TsgcFMXNotificationInbox et TsgcFMXNotificationPrefsEditor
  • C++Builder : les mêmes composants, avec des exemples C++ dans l'aide
  • .NET : TsgcWinFormsToastManager, TsgcWpfToastManager et TsgcAvaloniaToastManager, avec la boîte de réception et l'éditeur de préférences

La démo Realtime de la suite sgcUI construit une console d'exploitation avec une cloche dont le badge est le nombre de non-lus, et la boîte de réception de notifications au-dessus des préférences, en VCL, FireMonkey, C++Builder et .NET. Voir le pack UI Realtime.

Community et Registered

Les composants de notification suivent l'édition de leur produit, sgcNavigation, et le lien de badge suit sgcToolbar.

ÉlémentProduit.NET CommunityRegistered
Modèle de notification, toasts, boîte de réception et préférencessgcNavigationOuiOui
Lien de badge avec une barre d'outilssgcToolbarOuiOui
Lien de badge avec un rubansgcToolbarNoOui
Messages de notification en directsgcNavigationNoOui
Sources en direct par WebSocket, MQTT et SSE (nécessite sgcWebSockets)sgcUICoreNoOui

Dans Delphi et C++Builder, les composants de notification sont fournis avec sgcUI Standard, Professional, Enterprise, All-Access et l'essai, et avec sgcNavigation et sgcToolbar vendus seuls. Les packages .NET Community gratuits les incluent aussi. L'édition Delphi Community ne fournit que sgcGrid. Voir les tarifs de sgcUI.

Foire aux questions

Place un TsgcVCLToastManager sur la fiche, ou un TsgcFMXToastManager dans FireMonkey, et appelle Show avec un titre, un corps et une gravité. Le toast apparaît dans le coin que tu choisis, décompte cinq secondes par défaut, se met en pause tant que le pointeur est dessus et ne prend jamais le focus. Avec son Model défini, le gestionnaire affiche aussi un toast pour chaque nouvelle notification non lue.

Crée un TsgcNotificationModel et définis-le comme Model d'un TsgcVCLNotificationInbox, qui liste les notifications par jour avec des onglets Toutes et Non lues et un bouton Tout marquer comme lu. Définis ensuite le modèle comme Source d'un TsgcToolbarBadgeLink avec une barre d'outils comme Target : le nombre de non-lus s'affiche sur le bouton, sous la forme 99+ au-delà de 99.

Oui, dans l'édition Registered. Le serveur envoie un message JSON par changement, et ApplyMessage l'applique au modèle. Les sources en direct de la passerelle sgcUICoreWS lisent ces messages depuis un client WebSocket, MQTT ou événements envoyés par le serveur de sgcWebSockets et les appliquent dans le thread principal, si bien que les toasts, la boîte de réception et le badge se mettent à jour sans autre code.

Oui. TsgcFMXToastManager, TsgcFMXNotificationInbox et TsgcFMXNotificationPrefsEditor fonctionnent à partir de Delphi XE6. Les toasts FireMonkey vivent dans une superposition à l'intérieur de la fiche, sous Windows, macOS, Linux, iOS et Android. Le modèle est indépendant du framework, donc le même TsgcNotificationModel alimente les vues VCL et FireMonkey.

Oui. TsgcNotificationPreferences conserve les canaux que l'utilisateur souhaite pour chaque catégorie : dans l'application, fenêtre contextuelle, e-mail et push. L'éditeur de préférences les affiche sous forme de tableau de cases à cocher. Un gestionnaire de toasts avec Preferences défini n'affiche aucun toast pour une catégorie dont le canal de fenêtre contextuelle est désactivé, et la boîte de réception liste toujours ces notifications.

Oui, quand tu les enregistres. SaveToFile et LoadFromFile du modèle conservent les notifications entre les sessions sous forme de fichier JSON, et MaxCount (500 par défaut) borne le modèle en supprimant d'abord les plus anciennes notifications lues.

Les packages .NET Community gratuits incluent le modèle, les toasts, la boîte de réception et les préférences. L'édition Delphi Community ne fournit que sgcGrid, donc dans Delphi et C++Builder les composants de notification sont fournis avec sgcNavigation, vendu seul ou dans sgcUI Standard et au-dessus. L'essai All-Access inclut chaque produit sgcUI pour l'évaluation.

Meilleur rapport qualité-prix : All-AccessTous les produits eSeGeCe, Support Premium inclus, à partir de €1,059/an.
Voir les tarifs All-Access

Ajoute des notifications à ton application Delphi

Télécharge l'essai de sgcUI et essaie les toasts, la boîte de réception et le badge dans ton propre IDE.