Komponent powiadomień Delphi z toastami, skrzynką i znaczkami
sgcNavigation, część sgcUI, przynosi zestaw komponentów powiadomień Delphi do aplikacji VCL i FireMonkey, wszystko sterowane jednym modelem powiadomień.
sgcNavigation, część sgcUI, przynosi zestaw komponentów powiadomień Delphi do aplikacji VCL i FireMonkey, wszystko sterowane jednym modelem powiadomień.
Model niczego nie rysuje i jest niezależny od frameworka, więc jeden model zasila widoki VCL i FireMonkey tej samej aplikacji.
Jeden model powiadomień steruje powiadomieniami toast, skrzynką powiadomień grupowaną według dni, znaczkiem nieprzeczytanych i preferencjami według kategorii, a serwer może wypychać nowe powiadomienia na żywo przez WebSocket, MQTT lub zdarzenia wysyłane przez serwer.
| Komponent | Jednostka | Rola |
|---|---|---|
TsgcNotificationModel | sgcNavigation_Notification | Niewizualny. Przechowuje powiadomienia, zlicza nieprzeczytane, oznacza je jako przeczytane, odrzuca je i zapisuje jako JSON. |
TsgcVCLToastManager, TsgcFMXToastManager | sgcNavigation_Toast_VCL, sgcNavigation_Toast_FMX | Niewizualny. Pokazuje toast dla każdego nowego nieprzeczytanego powiadomienia modelu oraz samodzielne toasty z kodu. |
TsgcVCLNotificationInbox, TsgcFMXNotificationInbox | sgcNavigation_Inbox_VCL, sgcNavigation_Inbox_FMX | Kontrolka, która wyświetla powiadomienia według dni, z kartami All i Unread oraz przyciskiem Mark all as read. |
TsgcNotificationPreferences | sgcNavigation_NotifyPrefs | Niewizualny. Kanały (w aplikacji, wyskakujące okno, e-mail, push), których użytkownik chce dla każdej kategorii. |
TsgcVCLNotificationPrefsEditor, TsgcFMXNotificationPrefsEditor | sgcNavigation_NotifyPrefs_VCL, sgcNavigation_NotifyPrefs_FMX | Kontrolka, która pokazuje preferencje jako tabelę pól wyboru, jeden wiersz na kategorię. |
TsgcToolbarBadgeLink | sgcToolbar_BadgeLink | Niewizualny, w sgcToolbar. Pokazuje liczbę nieprzeczytanych modelu jako znaczek pozycji paska narzędzi lub wstążki, 99+ powyżej 99. |
TsgcUILiveSource_WebSocket, TsgcUILiveSource_MQTT, TsgcUILiveSource_SSE | Most sgcUICoreWS | Przekazuj modelowi wiadomości JSON wysyłane przez serwer przez połączenie sgcWebSockets (edycja Registered). |
Toast to krótka karta, która wyskakuje w rogu formularza lub ekranu, odlicza czas i sama się zamyka.
Toast ma symbol ważności lub obraz, tytuł, treść do trzech wierszy, przycisk zamknięcia i do dwóch przycisków akcji. Menedżer toastów to komponent niewizualny na formularzu: układa toasty w stos, odlicza je, wstrzymuje pod wskaźnikiem, wygasza i wygaszają się w płynny sposób oraz kolejkuje te, które się nie mieszczą.
Position wybiera róg lub krawędź, domyślnie tpsBottomRight, a Anchor menedżera VCL układa toasty w formularzu lub w obszarze roboczym ekranu.Duration wynosi domyślnie 5000 ms, a StickySeverities utrzymuje błędy na ekranie, dopóki użytkownik ich nie zamknie.MaxVisible (3) ogranicza liczbę toastów na ekranie. Następne czekają w kolejce.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;
W FireMonkey TsgcFMXToastManager ma te same właściwości bez Anchor. Toasty żyją w nakładce wewnątrz formularza, co działa w Windows, macOS, Linux, iOS i Android.
Model przechowuje powiadomienia jednego użytkownika. Toasty, skrzynka i znaczek podążają za nim bez żadnego innego kodu.
Powiadomienie ma Id, tytuł, treść w zwykłym tekście, ważność (info, success, warning lub error), czas UTC, stan odczytu, kategorię, źródło, które je zgłosiło, i przyciski akcji. Add dodaje nowe nieprzeczytane powiadomienie. Post to upsert według Id, więc klucz zamówienia, kompilacji lub zgłoszenia utrzymuje jedno powiadomienie aktualne zamiast dodawać drugie. MarkRead, MarkAllRead i Dismiss zmieniają stan, a SaveToFile i LoadFromFile zachowują powiadomienia między sesjami jako JSON.
TsgcToolbarBadgeLink pokazuje liczbę nieprzeczytanych na przycisku paska narzędzi albo, w edycji Registered, na przycisku wstążki.OnAction modelu z id akcji.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;
Zmiany wprowadzone między BeginUpdate a EndUpdate docierają do widoków jednorazowo, więc toast pokazuje gotowe powiadomienie z jego przyciskami. Model jest używany z wątku głównego.
VCL, jasny motyw: skrzynka nad preferencjami.
FireMonkey, jasny motyw.
Znaczki liczby przy Inbox, Tasks i Alerts na pasku bocznym.
Serwer utrzymuje powiadomienia użytkownika aktualne za pomocą wiadomości na żywo, jeden obiekt JSON na wiadomość.
ApplyMessage stosuje wiadomość do modelu: add, update, remove, read, unread lub snapshot. Toasty, skrzynka i znaczek podążają za modelem, więc wiadomość z serwera pojawia się na ekranie bez żadnego innego kodu. ApplyMessage nigdy nie zgłasza wyjątku. Zwraca False i pozostawia model bez zmian, gdy wiadomość nie jest dla niego.
{"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"}
Źródła na żywo mostu sgcUICoreWS biorą wiadomości klienta sgcWebSockets i przekazują je modelowi: TsgcUILiveSource_WebSocket dla TsgcWebSocketClient, TsgcUILiveSource_MQTT dla TsgcWSPClient_MQTT i TsgcUILiveSource_SSE dla zdarzeń wysyłanych przez serwer w TsgcHTTP1Client. Wiadomości, które docierają w wątku gniazda, są kolejkowane i stosowane w wątku głównym.
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;
OnNotification i OnAction modelu i wyślij własną ramkę przez tego samego klienta.Wiadomości na żywo i źródła na żywo są częścią edycji Registered, a źródła na żywo wymagają sgcWebSockets. Bez serwera aplikacja wywołuje Add i Post modelu.
Delphi 7 do Delphi 13 z VCL, FireMonkey od Delphi XE6, C++Builder oraz .NET WinForms, WPF i Avalonia.
TsgcVCLToastManager, TsgcVCLNotificationInbox i TsgcVCLNotificationPrefsEditorTsgcFMXToastManager, TsgcFMXNotificationInbox i TsgcFMXNotificationPrefsEditorTsgcWinFormsToastManager, TsgcWpfToastManager i TsgcAvaloniaToastManager, ze skrzynką i edytorem preferencjiDemo Realtime zestawu sgcUI buduje konsolę operacyjną z dzwonkiem, którego znaczkiem jest liczba nieprzeczytanych, i skrzynką powiadomień nad preferencjami, w VCL, FireMonkey, C++Builder i .NET. Zobacz pakiet Realtime UI.
Komponenty powiadomień podążają za edycją swojego produktu, sgcNavigation, a łącze znaczka podąża za sgcToolbar.
| Element | Produkt | .NET Community | Registered |
|---|---|---|---|
| Model powiadomień, toasty, skrzynka i preferencje | sgcNavigation | Tak | Tak |
| Łącze znaczka z paskiem narzędzi | sgcToolbar | Tak | Tak |
| Łącze znaczka ze wstążką | sgcToolbar | No | Tak |
| Wiadomości powiadomień na żywo | sgcNavigation | No | Tak |
| Źródła na żywo przez WebSocket, MQTT i SSE (wymaga sgcWebSockets) | sgcUICore | No | Tak |
W Delphi i C++Builder komponenty powiadomień są dostarczane z sgcUI Standard, Professional, Enterprise, All-Access i wersją próbną oraz z sgcNavigation i sgcToolbar sprzedawanymi osobno. Bezpłatne pakiety .NET Community również je zawierają. Edycja Delphi Community zawiera tylko sgcGrid. Zobacz cennik sgcUI.
Umieść na formularzu TsgcVCLToastManager albo TsgcFMXToastManager w FireMonkey i wywołaj Show z tytułem, treścią i ważnością. Toast wyskakuje w wybranym rogu, domyślnie odlicza pięć sekund, wstrzymuje się, gdy wskaźnik jest nad nim, i nigdy nie przejmuje fokusu. Z ustawionym Model menedżer pokazuje też toast dla każdego nowego nieprzeczytanego powiadomienia.
Utwórz TsgcNotificationModel i ustaw go jako Model dla TsgcVCLNotificationInbox, który wyświetla powiadomienia według dni z kartami All i Unread oraz przyciskiem Mark all as read. Następnie ustaw model jako Source dla TsgcToolbarBadgeLink z paskiem narzędzi jako Target: liczba nieprzeczytanych pokazuje się na przycisku, jako 99+ powyżej 99.
Tak, w edycji Registered. Serwer wysyła jedną wiadomość JSON na zmianę, a ApplyMessage stosuje ją do modelu. Źródła na żywo mostu sgcUICoreWS odczytują te wiadomości z klienta WebSocket, MQTT lub zdarzeń wysyłanych przez serwer z sgcWebSockets i stosują je w wątku głównym, więc toasty, skrzynka i znaczek aktualizują się bez żadnego innego kodu.
Tak. TsgcFMXToastManager, TsgcFMXNotificationInbox i TsgcFMXNotificationPrefsEditor działają od Delphi XE6. Toasty FireMonkey żyją w nakładce wewnątrz formularza, w Windows, macOS, Linux, iOS i Android. Model jest niezależny od frameworka, więc ten sam TsgcNotificationModel zasila widoki VCL i FireMonkey.
Tak. TsgcNotificationPreferences przechowuje kanały, których użytkownik chce dla każdej kategorii: w aplikacji, wyskakujące okno, e-mail i push. Edytor preferencji pokazuje je jako tabelę pól wyboru. Menedżer toastów z ustawionym Preferences nie pokazuje toastu dla kategorii, której kanał wyskakujących okien jest wyłączony, a skrzynka nadal wyświetla te powiadomienia.
Tak, gdy je zapiszesz. SaveToFile i LoadFromFile modelu zachowują powiadomienia między sesjami jako plik JSON, a MaxCount (domyślnie 500) ogranicza model, usuwając najpierw najstarsze przeczytane powiadomienia.
Bezpłatne pakiety .NET Community zawierają model, toasty, skrzynkę i preferencje. Edycja Delphi Community zawiera tylko sgcGrid, więc w Delphi i C++Builder komponenty powiadomień są dostarczane z sgcNavigation, sprzedawanym osobno lub w sgcUI Standard i wyższych. Wersja próbna All-Access zawiera każdy produkt sgcUI do oceny.