Delphi, C++Builder & .NET Parte do sgcUI

Um componente de notificação para Delphi com toasts, caixa de entrada e indicadores

O sgcNavigation, parte do sgcUI, traz um conjunto de componentes de notificação para Delphi a aplicativos VCL e FireMonkey, todos controlados por um único modelo de notificação.

Notificações toast
Caixa de entrada agrupada por dia
Indicador de não lidas
Push ao vivo por WebSocket, MQTT ou SSE
VCLFireMonkeyC++BuilderWinForms, WPF, Avalonia

Veja o código →

Componente de notificação para Delphi em um aplicativo VCL, tema escuro: a caixa de notificações com 6 não lidas, preferências por categoria para no aplicativo, pop-up, e-mail e push, um feed de atividades e uma lista da equipe

Os componentes de notificação

O modelo não desenha nada e é neutro em relação ao framework, então um único modelo alimenta as visões VCL e FireMonkey do mesmo aplicativo.

Um único modelo de notificação controla as notificações toast, uma caixa de notificações agrupada por dia, um indicador de não lidas e preferências por categoria, e um servidor pode enviar novas notificações ao vivo por WebSocket, MQTT ou server-sent events.

ComponenteUnitFunção
TsgcNotificationModelsgcNavigation_NotificationNão visual. Guarda as notificações, conta as não lidas, as marca como lidas, as descarta e as salva como JSON.
TsgcVCLToastManager, TsgcFMXToastManagersgcNavigation_Toast_VCL, sgcNavigation_Toast_FMXNão visual. Mostra um toast para cada nova notificação não lida do modelo e toasts independentes a partir do código.
TsgcVCLNotificationInbox, TsgcFMXNotificationInboxsgcNavigation_Inbox_VCL, sgcNavigation_Inbox_FMXUm controle que lista as notificações por dia, com abas Todas e Não lidas e um botão Marcar todas como lidas.
TsgcNotificationPreferencessgcNavigation_NotifyPrefsNão visual. Os canais (no aplicativo, pop-up, e-mail, push) que o usuário quer para cada categoria.
TsgcVCLNotificationPrefsEditor, TsgcFMXNotificationPrefsEditorsgcNavigation_NotifyPrefs_VCL, sgcNavigation_NotifyPrefs_FMXUm controle que mostra as preferências como uma tabela de caixas de seleção, uma linha por categoria.
TsgcToolbarBadgeLinksgcToolbar_BadgeLinkNão visual, no sgcToolbar. Mostra a contagem de não lidas do modelo como o indicador de um item de barra de ferramentas ou de faixa de opções, 99+ acima de 99.
TsgcUILiveSource_WebSocket, TsgcUILiveSource_MQTT, TsgcUILiveSource_SSEPonte sgcUICoreWSEntregue ao modelo as mensagens JSON que um servidor envia por uma conexão sgcWebSockets (edição Registered).

Mostre notificações toast em um aplicativo Delphi

Um toast é um cartão curto que aparece em um canto do formulário ou da tela, faz uma contagem regressiva e se fecha sozinho.

Um toast tem um glifo de gravidade ou uma imagem, um título, um corpo de até três linhas, um botão de fechar e até dois botões de ação. O gerenciador de toasts é um componente não visual no formulário: ele empilha os toasts, faz a contagem regressiva, os pausa sob o ponteiro, os exibe e os oculta com fade e enfileira os que não cabem.

  • Position escolhe o canto ou a borda, tpsBottomRight por padrão, e Anchor do gerenciador VCL empilha os toasts no formulário ou na área de trabalho da tela.
  • Duration é de 5000 ms por padrão, e StickySeverities mantém os erros na tela até que o usuário os feche.
  • MaxVisible (3) limita os toasts na tela; os seguintes esperam em uma fila.
  • Um toast nunca ativa uma janela e nunca toma o foco, então o usuário continua digitando. Um leitor de tela lê cada novo toast.
Delphi VCL, um gerenciador de toasts e um toast independente
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;

No FireMonkey, o TsgcFMXToastManager tem as mesmas propriedades, sem Anchor. Os toasts ficam em uma sobreposição dentro do formulário, o que funciona no Windows, macOS, Linux, iOS e Android.

Leia o tópico de ajuda Toasts

Uma caixa de notificações com indicador de não lidas

O modelo guarda as notificações de um usuário; os toasts, a caixa de entrada e o indicador o acompanham sem nenhum outro código.

Uma notificação tem um Id, um título, um corpo em texto simples, uma gravidade (info, success, warning ou error), uma hora UTC, um estado de leitura, uma categoria, a origem que a gerou e botões de ação. Add adiciona uma nova notificação não lida. Post é um upsert por Id, então a chave de um pedido, de um build ou de um ticket mantém uma notificação atualizada em vez de adicionar uma segunda. MarkRead, MarkAllRead e Dismiss alteram o estado, e SaveToFile e LoadFromFile mantêm as notificações entre sessões como JSON.

  • Caixa de entrada: as notificações agrupadas por dia, todas ou somente as não lidas, com Marcar todas como lidas.
  • Indicador de não lidas: TsgcToolbarBadgeLink mostra a contagem de não lidas em um botão da barra de ferramentas, ou em um botão da faixa de opções na edição Registered.
  • Preferências: uma linha por categoria e uma coluna por canal. Desativar o canal pop-up de uma categoria interrompe seus toasts, e a caixa de entrada continua listando-os.
  • Ações: um clique em um botão de ação, em um toast ou na caixa de entrada, dispara OnAction do modelo com o id da ação.
Delphi VCL, a central de notificações completa
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;

As alterações feitas entre BeginUpdate e EndUpdate chegam às visões uma única vez, então o toast mostra a notificação final com seus botões. O modelo é usado a partir da thread principal.

Leia o tópico de ajuda Notifications

Notificações push de um servidor por WebSocket, MQTT ou SSE

Um servidor mantém as notificações de um usuário atualizadas com mensagens ao vivo, um objeto JSON por mensagem.

ApplyMessage aplica uma mensagem ao modelo: add, update, remove, read, unread ou snapshot. Os toasts, a caixa de entrada e o indicador acompanham o modelo, então uma mensagem do servidor aparece na tela sem nenhum outro código. ApplyMessage nunca dispara exceção; ele retorna False e deixa o modelo inalterado quando uma mensagem não é para ele.

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

As fontes ao vivo da ponte sgcUICoreWS recebem as mensagens de um cliente sgcWebSockets e as entregam ao modelo: TsgcUILiveSource_WebSocket para um TsgcWebSocketClient, TsgcUILiveSource_MQTT para um TsgcWSPClient_MQTT e TsgcUILiveSource_SSE para os server-sent events de um TsgcHTTP1Client. As mensagens que chegam em uma thread de socket são enfileiradas e aplicadas na thread principal.

Delphi, notificações de um 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;
  • A fonte nunca conecta, assina nem envia. A URL, as credenciais, o TLS e a reconexão pertencem ao cliente.
  • A ponte é somente de entrada. Quando o usuário lê ou descarta uma notificação, trate OnNotification e OnAction do modelo e envie seu próprio quadro pelo mesmo cliente.

As mensagens ao vivo e as fontes ao vivo fazem parte da edição Registered, e as fontes ao vivo exigem o sgcWebSockets. Sem um servidor, o aplicativo chama Add e Post do modelo.

Leia o tópico de ajuda Notification Live Messages

VCL, FireMonkey, C++Builder e .NET

Delphi 7 ao Delphi 13 com VCL, FireMonkey a partir do Delphi XE6, C++Builder e .NET WinForms, WPF e Avalonia.

A demo Realtime para Delphi FireMonkey no tema escuro, com a caixa de notificações e o indicador de não lidas

Um modelo, todos os front-ends

  • VCL: TsgcVCLToastManager, TsgcVCLNotificationInbox e TsgcVCLNotificationPrefsEditor
  • FireMonkey: TsgcFMXToastManager, TsgcFMXNotificationInbox e TsgcFMXNotificationPrefsEditor
  • C++Builder: os mesmos componentes, com exemplos em C++ na ajuda
  • .NET: TsgcWinFormsToastManager, TsgcWpfToastManager e TsgcAvaloniaToastManager, com a caixa de entrada e o editor de preferências

A demo Realtime da suíte sgcUI cria um console de operações com um sino cujo indicador é a contagem de não lidas e a caixa de notificações acima das preferências, em VCL, FireMonkey, C++Builder e .NET. Veja o pacote de interface Realtime.

Community e Registered

Os componentes de notificação seguem a edição do seu produto, o sgcNavigation, e o link de indicador segue o sgcToolbar.

PeçaProduto.NET CommunityRegistered
Modelo de notificação, toasts, caixa de entrada e preferênciassgcNavigationSimSim
Link de indicador com uma barra de ferramentassgcToolbarSimSim
Link de indicador com uma faixa de opçõessgcToolbarNoSim
Mensagens de notificação ao vivosgcNavigationNoSim
Fontes ao vivo por WebSocket, MQTT e SSE (exige o sgcWebSockets)sgcUICoreNoSim

No Delphi e no C++Builder, os componentes de notificação vêm com o sgcUI Standard, Professional, Enterprise, All-Access e com a versão de avaliação, e com o sgcNavigation e o sgcToolbar vendidos separadamente. Os pacotes .NET Community gratuitos também os incluem. A edição Delphi Community inclui apenas o sgcGrid. Veja os preços do sgcUI.

Perguntas frequentes

Coloque um TsgcVCLToastManager no formulário, ou um TsgcFMXToastManager no FireMonkey, e chame Show com um título, um corpo e uma gravidade. O toast aparece no canto que você escolher, faz uma contagem regressiva de cinco segundos por padrão, pausa enquanto o ponteiro está sobre ele e nunca toma o foco. Com seu Model definido, o gerenciador também mostra um toast para cada nova notificação não lida.

Crie um TsgcNotificationModel e defina-o como o Model de um TsgcVCLNotificationInbox, que lista as notificações por dia com abas Todas e Não lidas e um botão Marcar todas como lidas. Depois defina o modelo como o Source de um TsgcToolbarBadgeLink com uma barra de ferramentas como Target: a contagem de não lidas aparece no botão, como 99+ acima de 99.

Sim, na edição Registered. O servidor envia uma mensagem JSON por alteração, e o ApplyMessage a aplica ao modelo. As fontes ao vivo da ponte sgcUICoreWS leem essas mensagens de um cliente WebSocket, MQTT ou server-sent events do sgcWebSockets e as aplicam na thread principal, então os toasts, a caixa de entrada e o indicador são atualizados sem nenhum outro código.

Sim. TsgcFMXToastManager, TsgcFMXNotificationInbox e TsgcFMXNotificationPrefsEditor funcionam a partir do Delphi XE6. Os toasts do FireMonkey ficam em uma sobreposição dentro do formulário, no Windows, macOS, Linux, iOS e Android. O modelo é neutro em relação ao framework, então o mesmo TsgcNotificationModel alimenta as visões VCL e FireMonkey.

Sim. O TsgcNotificationPreferences guarda os canais que o usuário quer para cada categoria: no aplicativo, pop-up, e-mail e push. O editor de preferências os mostra como uma tabela de caixas de seleção. Um gerenciador de toasts com Preferences definido não mostra toast para uma categoria cujo canal pop-up está desativado, e a caixa de entrada continua listando essas notificações.

Sim, quando você as salva. SaveToFile e LoadFromFile do modelo mantêm as notificações entre sessões como um arquivo JSON, e MaxCount (500 por padrão) limita o modelo, descartando primeiro as notificações lidas mais antigas.

Os pacotes .NET Community gratuitos incluem o modelo, os toasts, a caixa de entrada e as preferências. A edição Delphi Community inclui apenas o sgcGrid, então no Delphi e no C++Builder os componentes de notificação vêm com o sgcNavigation, vendido separadamente ou no sgcUI Standard e superiores. A versão de avaliação All-Access inclui todos os produtos sgcUI para avaliação.

Melhor custo-benefício: All-AccessTodos os produtos da eSeGeCe, com Suporte Premium incluído, a partir de €1,059/ano.
Ver preços do All-Access

Adicione notificações ao seu aplicativo Delphi

Baixe a versão de avaliação do sgcUI e experimente os toasts, a caixa de entrada e o indicador na sua própria IDE.