Delphi, C++Builder y .NET Parte de sgcUI

Un componente de notificaciones para Delphi con avisos, una bandeja e insignias

sgcNavigation, parte de sgcUI, aporta un conjunto de componentes de notificaciones para Delphi a aplicaciones VCL y FireMonkey, todos controlados por un único modelo de notificaciones.

Avisos emergentes
Bandeja agrupada por día
Insignia de no leídas
Push en vivo mediante WebSocket, MQTT o SSE
VCLFireMonkeyC++BuilderWinForms, WPF, Avalonia

Ver el código →

Componente de notificaciones para Delphi en una aplicación VCL, tema oscuro: la bandeja de notificaciones con 6 sin leer, preferencias por categoría para en la aplicación, emergente, correo y push, un feed de actividad y una lista del equipo

Los componentes de notificaciones

El modelo no dibuja nada y es independiente del framework, así que un único modelo alimenta las vistas VCL y FireMonkey de la misma aplicación.

Un único modelo de notificaciones controla los avisos emergentes, una bandeja de notificaciones agrupada por día, una insignia de no leídas y las preferencias por categoría, y un servidor puede enviar nuevas notificaciones en vivo mediante WebSocket, MQTT o server-sent events.

ComponenteUnidadFunción
TsgcNotificationModelsgcNavigation_NotificationNo visual. Guarda las notificaciones, cuenta las no leídas, las marca como leídas, las descarta y las guarda como JSON.
TsgcVCLToastManager, TsgcFMXToastManagersgcNavigation_Toast_VCL, sgcNavigation_Toast_FMXNo visual. Muestra un aviso por cada nueva notificación no leída del modelo, y avisos independientes desde código.
TsgcVCLNotificationInbox, TsgcFMXNotificationInboxsgcNavigation_Inbox_VCL, sgcNavigation_Inbox_FMXUn control que enumera las notificaciones por día, con pestañas Todas y No leídas y un botón Marcar todo como leído.
TsgcNotificationPreferencessgcNavigation_NotifyPrefsNo visual. Los canales (en la aplicación, emergente, correo, push) que el usuario quiere para cada categoría.
TsgcVCLNotificationPrefsEditor, TsgcFMXNotificationPrefsEditorsgcNavigation_NotifyPrefs_VCL, sgcNavigation_NotifyPrefs_FMXUn control que muestra las preferencias como una tabla de casillas, una fila por categoría.
TsgcToolbarBadgeLinksgcToolbar_BadgeLinkNo visual, en sgcToolbar. Muestra el recuento de no leídas del modelo como insignia de un elemento de la barra de herramientas o del ribbon, 99+ por encima de 99.
TsgcUILiveSource_WebSocket, TsgcUILiveSource_MQTT, TsgcUILiveSource_SSEPuente sgcUICoreWSPasa al modelo los mensajes JSON que un servidor envía por una conexión de sgcWebSockets (edición Registered).

Muestra avisos emergentes en una aplicación Delphi

Un aviso es una tarjeta corta que aparece en una esquina del formulario o de la pantalla, hace una cuenta atrás y se cierra sola.

Un aviso tiene un glifo de gravedad o una imagen, un título, un cuerpo de hasta tres líneas, un botón de cierre y hasta dos botones de acción. El gestor de avisos es un componente no visual en el formulario: apila los avisos, hace su cuenta atrás, los pausa bajo el puntero, los desvanece al entrar y salir y pone en cola los que no caben.

  • Position elige la esquina o el borde, tpsBottomRight de forma predeterminada, y Anchor del gestor VCL apila los avisos en el formulario o en el área de trabajo de la pantalla.
  • Duration es 5000 ms de forma predeterminada, y StickySeverities mantiene los errores en pantalla hasta que el usuario los cierra.
  • MaxVisible (3) limita los avisos en pantalla; los siguientes esperan en una cola.
  • Un aviso nunca activa una ventana ni toma el foco, así que el usuario sigue escribiendo. Un lector de pantalla lee cada aviso nuevo.
Delphi VCL, un gestor de avisos y un aviso independiente
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;

En FireMonkey, TsgcFMXToastManager tiene las mismas propiedades sin Anchor. Los avisos viven en una superposición dentro del formulario, que funciona en Windows, macOS, Linux, iOS y Android.

Lee el tema de ayuda sobre avisos

Una bandeja de notificaciones con insignia de no leídas

El modelo guarda las notificaciones de un usuario; los avisos, la bandeja y la insignia lo siguen sin más código.

Una notificación tiene un Id, un título, un cuerpo de texto sin formato, una gravedad (info, success, warning o error), una hora UTC, un estado de lectura, una categoría, el origen que la generó y botones de acción. Add añade una nueva notificación no leída. Post es un upsert por Id, así que la clave de un pedido, una compilación o un ticket mantiene una notificación actualizada en lugar de añadir una segunda. MarkRead, MarkAllRead y Dismiss cambian el estado, y SaveToFile y LoadFromFile conservan las notificaciones entre sesiones como JSON.

  • Bandeja: las notificaciones agrupadas por día, todas o solo las no leídas, con Marcar todo como leído.
  • Insignia de no leídas: TsgcToolbarBadgeLink muestra el recuento de no leídas en un botón de la barra de herramientas, o en un botón del ribbon en la edición Registered.
  • Preferencias: una fila por categoría y una columna por canal. Desactivar el canal emergente de una categoría detiene sus avisos, y la bandeja sigue enumerándolos.
  • Acciones: un clic en un botón de acción, en un aviso o en la bandeja, lanza OnAction del modelo con el id de la acción.
Delphi VCL, todo el centro de notificaciones
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;

Los cambios hechos entre BeginUpdate y EndUpdate llegan a las vistas una sola vez, así que el aviso muestra la notificación terminada con sus botones. El modelo se usa desde el hilo principal.

Lee el tema de ayuda sobre notificaciones

Notificaciones push desde un servidor mediante WebSocket, MQTT o SSE

Un servidor mantiene al día las notificaciones de un usuario con mensajes en vivo, un objeto JSON por mensaje.

ApplyMessage aplica un mensaje al modelo: add, update, remove, read, unread o snapshot. Los avisos, la bandeja y la insignia siguen al modelo, así que un mensaje del servidor aparece en pantalla sin más código. ApplyMessage nunca lanza una excepción; devuelve False y deja el modelo sin cambios cuando un mensaje no es para él.

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

Las fuentes en vivo del puente sgcUICoreWS toman los mensajes de un cliente de sgcWebSockets y se los pasan al modelo: TsgcUILiveSource_WebSocket para un TsgcWebSocketClient, TsgcUILiveSource_MQTT para un TsgcWSPClient_MQTT y TsgcUILiveSource_SSE para los server-sent events de un TsgcHTTP1Client. Los mensajes que llegan en un hilo de socket se ponen en cola y se aplican en el hilo principal.

Delphi, notificaciones desde 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 fuente nunca se conecta, se suscribe ni envía. La URL, las credenciales, TLS y la reconexión corresponden al cliente.
  • El puente es solo de entrada. Cuando el usuario lee o descarta una notificación, gestiona OnNotification y OnAction del modelo y envía tu propia trama por el mismo cliente.

Los mensajes en vivo y las fuentes en vivo forman parte de la edición Registered, y las fuentes en vivo requieren sgcWebSockets. Sin servidor, la aplicación llama a Add y Post del modelo.

Lee el tema de ayuda sobre mensajes en vivo de notificaciones

VCL, FireMonkey, C++Builder y .NET

Delphi 7 a Delphi 13 con VCL, FireMonkey desde Delphi XE6, C++Builder, y .NET WinForms, WPF y Avalonia.

La demo Realtime para Delphi FireMonkey en el tema oscuro, con la bandeja de notificaciones y la insignia de no leídas

Un modelo, todos los front-ends

  • VCL: TsgcVCLToastManager, TsgcVCLNotificationInbox y TsgcVCLNotificationPrefsEditor
  • FireMonkey: TsgcFMXToastManager, TsgcFMXNotificationInbox y TsgcFMXNotificationPrefsEditor
  • C++Builder: los mismos componentes, con ejemplos en C++ en la ayuda
  • .NET: TsgcWinFormsToastManager, TsgcWpfToastManager y TsgcAvaloniaToastManager, con la bandeja y el editor de preferencias

La demo Realtime de la suite sgcUI construye una consola de operaciones con una campana cuya insignia es el recuento de no leídas, y la bandeja de notificaciones sobre las preferencias, en VCL, FireMonkey, C++Builder y .NET. Consulta el paquete de UI Realtime.

Community y Registered

Los componentes de notificaciones siguen la edición de su producto, sgcNavigation, y el enlace de insignia sigue a sgcToolbar.

PiezaProducto.NET CommunityRegistered
Modelo de notificaciones, avisos, bandeja y preferenciassgcNavigationSíSí
Enlace de insignia con una barra de herramientassgcToolbarSíSí
Enlace de insignia con un ribbonsgcToolbarNoSí
Mensajes de notificación en vivosgcNavigationNoSí
Fuentes en vivo mediante WebSocket, MQTT y SSE (requiere sgcWebSockets)sgcUICoreNoSí

En Delphi y C++Builder los componentes de notificaciones vienen con sgcUI Standard, Professional, Enterprise, All-Access y la prueba, y con sgcNavigation y sgcToolbar vendidos por separado. Los paquetes .NET Community gratuitos también los incluyen. La edición Delphi Community solo incluye sgcGrid. Consulta los precios de sgcUI.

Preguntas frecuentes

Pon un TsgcVCLToastManager en el formulario, o un TsgcFMXToastManager en FireMonkey, y llama a Show con un título, un cuerpo y una gravedad. El aviso aparece en la esquina que elijas, hace una cuenta atrás de cinco segundos de forma predeterminada, se pausa mientras el puntero está encima y nunca toma el foco. Con su Model establecido, el gestor también muestra un aviso por cada nueva notificación no leída.

Crea un TsgcNotificationModel y establécelo como Model de un TsgcVCLNotificationInbox, que enumera las notificaciones por día con pestañas Todas y No leídas y un botón Marcar todo como leído. Después establece el modelo como Source de un TsgcToolbarBadgeLink con una barra de herramientas como Target: el recuento de no leídas aparece en el botón, como 99+ por encima de 99.

Sí, en la edición Registered. El servidor envía un mensaje JSON por cada cambio, y ApplyMessage lo aplica al modelo. Las fuentes en vivo del puente sgcUICoreWS leen esos mensajes de un cliente WebSocket, MQTT o server-sent events de sgcWebSockets y los aplican en el hilo principal, así que los avisos, la bandeja y la insignia se actualizan sin más código.

Sí. TsgcFMXToastManager, TsgcFMXNotificationInbox y TsgcFMXNotificationPrefsEditor funcionan desde Delphi XE6. Los avisos de FireMonkey viven en una superposición dentro del formulario, en Windows, macOS, Linux, iOS y Android. El modelo es independiente del framework, así que el mismo TsgcNotificationModel alimenta vistas VCL y FireMonkey.

Sí. TsgcNotificationPreferences guarda los canales que el usuario quiere para cada categoría: en la aplicación, emergente, correo y push. El editor de preferencias los muestra como una tabla de casillas. Un gestor de avisos con Preferences establecido no muestra ningún aviso para una categoría cuyo canal emergente está desactivado, y la bandeja sigue enumerando esas notificaciones.

Sí, cuando las guardas. SaveToFile y LoadFromFile del modelo conservan las notificaciones entre sesiones como un archivo JSON, y MaxCount (500 de forma predeterminada) limita el modelo, descartando primero las notificaciones leídas más antiguas.

Los paquetes .NET Community gratuitos incluyen el modelo, los avisos, la bandeja y las preferencias. La edición Delphi Community solo incluye sgcGrid, así que en Delphi y C++Builder los componentes de notificaciones vienen con sgcNavigation, vendido por separado o en sgcUI Standard y superiores. La prueba All-Access incluye todos los productos sgcUI para evaluación.

La mejor opción: All-AccessTodos los productos de eSeGeCe, con Premium Support incluido, desde €1,059 al año.
Ver precios de All-Access

Añade notificaciones a tu aplicación Delphi

Descarga la prueba de sgcUI y prueba los avisos, la bandeja y la insignia en tu propio IDE.