Delphi、C++Builder、.NET sgcUI の一部

トースト、受信トレイ、バッジを備えた Delphi 通知コンポーネント

sgcUI の一部である sgcNavigation は、VCL と FireMonkey アプリケーション向けに、1 つの通知モデルで動作する Delphi 通知コンポーネントセットを提供します。

トースト通知
日ごとにグループ化された受信トレイ
未読バッジ
WebSocket、MQTT、SSE によるライブプッシュ
VCLFireMonkeyC++BuilderWinForms、WPF、Avalonia

コードを見る →

ダークテーマの VCL アプリケーションにある Delphi 通知コンポーネント。未読 6 件の通知の受信トレイ、アプリ内、ポップアップ、メール、プッシュのカテゴリごとの設定、アクティビティフィード、チームの名簿

通知コンポーネント

モデルは何も描画せず、フレームワーク非依存のため、1 つのモデルが同じアプリケーションの VCL と FireMonkey のビューに通知を供給します。

1 つの通知モデルが、トースト通知、日ごとにグループ化された通知の受信トレイ、未読バッジ、カテゴリごとの設定を動かし、サーバーは WebSocket、MQTT、Server-Sent Events で新しい通知をライブでプッシュできます。

コンポーネントユニット役割
TsgcNotificationModelsgcNavigation_Notification非ビジュアル。通知を保持し、未読を数え、既読にし、破棄し、JSON として保存します。
TsgcVCLToastManager, TsgcFMXToastManagersgcNavigation_Toast_VCL, sgcNavigation_Toast_FMX非ビジュアル。モデルの新しい未読通知ごとにトーストを表示し、コードからのスタンドアロンのトーストも表示します。
TsgcVCLNotificationInbox, TsgcFMXNotificationInboxsgcNavigation_Inbox_VCL, sgcNavigation_Inbox_FMX通知を日ごとに一覧表示するコントロール。All タブと Unread タブ、Mark all as read ボタンを備えています。
TsgcNotificationPreferencessgcNavigation_NotifyPrefs非ビジュアル。カテゴリごとにユーザーが希望するチャネル (アプリ内、ポップアップ、メール、プッシュ)。
TsgcVCLNotificationPrefsEditor, TsgcFMXNotificationPrefsEditorsgcNavigation_NotifyPrefs_VCL, sgcNavigation_NotifyPrefs_FMX設定を、カテゴリごとに 1 行のチェックボックスのテーブルとして表示するコントロール。
TsgcToolbarBadgeLinksgcToolbar_BadgeLinksgcToolbar にある非ビジュアル。モデルの未読数を、ツールバーまたはリボンの項目のバッジとして表示します。99 を超えると 99+ になります。
TsgcUILiveSource_WebSocket, TsgcUILiveSource_MQTT, TsgcUILiveSource_SSEsgcUICoreWS ブリッジサーバーが sgcWebSockets の接続で送信する JSON メッセージをモデルに渡します (Registered エディション)。

Delphi アプリでトースト通知を表示

トーストは、フォームまたは画面の隅にポップアップし、カウントダウンして自動的に閉じる短いカードです。

トーストには、重大度のグリフまたは画像、タイトル、最大 3 行の本文、閉じるボタン、最大 2 つのアクションボタンがあります。トーストマネージャーはフォーム上の非ビジュアルコンポーネントで、トーストを積み重ね、カウントダウンし、ポインターが乗っている間は一時停止し、フェードイン/アウトし、収まらないものをキューに入れます。

  • Position は隅または端を選び、既定は tpsBottomRight です。VCL マネージャーの Anchor は、フォームまたは画面の作業領域のどちらにトーストを積み重ねるかを決めます。
  • Duration の既定は 5000 ミリ秒で、StickySeverities は、ユーザーが閉じるまでエラーを画面に残します。
  • MaxVisible (3) は画面上のトーストを制限し、次のトーストはキューで待機します。
  • トーストはウィンドウをアクティブにせず、フォーカスも奪わないため、ユーザーは入力を続けられます。スクリーンリーダーは、新しいトーストをそれぞれ読み上げます。
Delphi VCL、トーストマネージャーとスタンドアロンのトースト
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;

FireMonkey では、TsgcFMXToastManager は Anchor を除いて同じプロパティを備えています。トーストはフォーム内のオーバーレイに表示され、Windows、macOS、Linux、iOS、Android で動作します。

トーストのヘルプトピックを読む

未読バッジ付きの通知受信トレイ

モデルは 1 人のユーザーの通知を保持し、トースト、受信トレイ、バッジは、ほかのコードなしでそれに追従します。

通知には、Id、タイトル、プレーンテキストの本文、重大度 (info、success、warning、error)、UTC の時刻、既読の状態、カテゴリ、発生元、アクションボタンがあります。Add は新しい未読の通知を追加します。Post は Id による upsert のため、注文、ビルド、チケットのキーを使えば、2 つ目を追加せずに 1 つの通知を最新の状態に保てます。MarkRead、MarkAllRead、Dismiss は状態を変更し、SaveToFile と LoadFromFile は、通知をセッションをまたいで JSON として保持します。

  • 受信トレイ: 日ごとにグループ化された通知。すべて、または未読のみを表示でき、Mark all as read があります。
  • 未読バッジ: TsgcToolbarBadgeLink は、ツールバーのボタン、または Registered エディションではリボンのボタンに、未読数を表示します。
  • 設定: カテゴリごとに 1 行、チャネルごとに 1 列。カテゴリのポップアップチャネルをオフにすると、そのトーストは表示されなくなりますが、受信トレイには引き続き一覧表示されます。
  • アクション: トーストまたは受信トレイでアクションボタンをクリックすると、アクションの ID とともにモデルの OnAction が発生します。
Delphi VCL、通知センター全体
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;

BeginUpdate と EndUpdate の間で行った変更は 1 回だけビューに反映されるため、トーストにはボタン付きの完成した通知が表示されます。モデルはメインスレッドから使用します。

通知のヘルプトピックを読む

WebSocket、MQTT、SSE でサーバーからプッシュ通知

サーバーは、メッセージごとに 1 つの JSON オブジェクトを使うライブメッセージで、ユーザーの通知を最新の状態に保ちます。

ApplyMessage は、メッセージをモデルに適用します。add、update、remove、read、unread、snapshot に対応します。トースト、受信トレイ、バッジはモデルに追従するため、サーバーからのメッセージは、ほかのコードなしで画面に表示されます。ApplyMessage は例外を発生させず、メッセージが対象外の場合は False を返してモデルを変更しません。

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

sgcUICoreWS ブリッジのライブソースは、sgcWebSockets クライアントのメッセージを受け取り、モデルに渡します。TsgcWebSocketClient には TsgcUILiveSource_WebSocket、TsgcWSPClient_MQTT には TsgcUILiveSource_MQTT、TsgcHTTP1Client の Server-Sent Events には TsgcUILiveSource_SSE を使います。ソケットスレッドで届いたメッセージはキューに入れられ、メインスレッドで適用されます。

Delphi、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;
  • ソースは、接続、サブスクライブ、送信を一切行いません。URL、認証情報、TLS、再接続はクライアントが担います。
  • ブリッジは受信専用です。ユーザーが通知を既読にしたり破棄したりしたときは、モデルの OnNotification と OnAction を処理し、同じクライアントを通じて独自のフレームを送信します。

ライブメッセージとライブソースは Registered エディションの一部で、ライブソースには sgcWebSockets が必要です。サーバーがない場合、アプリケーションはモデルの Add と Post を呼び出します。

通知のライブメッセージのヘルプトピックを読む

VCL、FireMonkey、C++Builder、.NET

Delphi 7〜Delphi 13 の VCL、Delphi XE6 からの FireMonkey、C++Builder、そして .NET の WinForms、WPF、Avalonia に対応します。

ダークテーマの Delphi FireMonkey 向け Realtime デモ。通知の受信トレイと未読バッジ

1 つのモデルで、すべてのフロントエンドに対応

  • VCL: TsgcVCLToastManager、TsgcVCLNotificationInbox、TsgcVCLNotificationPrefsEditor
  • FireMonkey: TsgcFMXToastManager、TsgcFMXNotificationInbox、TsgcFMXNotificationPrefsEditor
  • C++Builder: 同じコンポーネントで、ヘルプに C++ の例があります
  • .NET: TsgcWinFormsToastManager、TsgcWpfToastManager、TsgcAvaloniaToastManager、および受信トレイと設定エディター

sgcUI スイートの Realtime デモは、未読数をバッジにしたベルと、設定の上の通知の受信トレイを備えたオペレーションコンソールを、VCL、FireMonkey、C++Builder、.NET で構築します。Realtime UI パックをご覧ください。

Community と Registered

通知コンポーネントは、所属する製品 sgcNavigation のエディションに従い、バッジリンクは sgcToolbar に従います。

要素製品.NET CommunityRegistered
通知モデル、トースト、受信トレイ、設定sgcNavigationありあり
ツールバーとのバッジリンクsgcToolbarありあり
リボンとのバッジリンクsgcToolbarNoあり
ライブ通知メッセージsgcNavigationNoあり
WebSocket、MQTT、SSE によるライブソース (sgcWebSockets が必要)sgcUICoreNoあり

Delphi と C++Builder では、通知コンポーネントは、sgcUI の Standard、Professional、Enterprise、All-Access、体験版に含まれ、単体で販売している sgcNavigation と sgcToolbar にも含まれます。無償の .NET Community パッケージにも含まれます。Delphi Community エディションには sgcGrid のみが含まれます。sgcUI の価格をご覧ください。

よくある質問

フォームに TsgcVCLToastManager を配置するか、FireMonkey では TsgcFMXToastManager を配置し、タイトル、本文、重大度を指定して Show を呼び出します。トーストは選択した隅にポップアップし、既定で 5 秒間カウントダウンし、ポインターが乗っている間は一時停止し、フォーカスを奪いません。Model を設定すると、マネージャーは新しい未読通知ごとにトーストも表示します。

TsgcNotificationModel を作成し、TsgcVCLNotificationInbox の Model に設定します。受信トレイは、All タブと Unread タブ、Mark all as read ボタンを備え、通知を日ごとに一覧表示します。次に、そのモデルを TsgcToolbarBadgeLink の Source に設定し、Target にツールバーを指定します。未読数がボタンに表示され、99 を超えると 99+ になります。

はい、Registered エディションで可能です。サーバーは変更ごとに 1 つの JSON メッセージを送信し、ApplyMessage がそれをモデルに適用します。sgcUICoreWS ブリッジのライブソースは、sgcWebSockets の WebSocket、MQTT、Server-Sent Events のクライアントからそれらのメッセージを読み取ってメインスレッドで適用するため、トースト、受信トレイ、バッジは、ほかのコードなしで更新されます。

はい。TsgcFMXToastManager、TsgcFMXNotificationInbox、TsgcFMXNotificationPrefsEditor は Delphi XE6 から動作します。FireMonkey のトーストは、Windows、macOS、Linux、iOS、Android で、フォーム内のオーバーレイに表示されます。モデルはフレームワーク非依存のため、同じ TsgcNotificationModel が VCL と FireMonkey のビューに通知を供給します。

はい。TsgcNotificationPreferences は、カテゴリごとにユーザーが希望するチャネル (アプリ内、ポップアップ、メール、プッシュ) を保持します。設定エディターは、それらをチェックボックスのテーブルとして表示します。Preferences を設定したトーストマネージャーは、ポップアップチャネルがオフのカテゴリのトーストを表示せず、受信トレイには引き続きそれらの通知が一覧表示されます。

はい、保存した場合です。モデルの SaveToFile と LoadFromFile は、通知をセッションをまたいで JSON ファイルとして保持し、MaxCount (既定は 500) がモデルの上限となり、最も古い既読の通知から順に破棄します。

無償の .NET Community パッケージには、モデル、トースト、受信トレイ、設定が含まれます。Delphi Community エディションには sgcGrid のみが含まれるため、Delphi と C++Builder では、通知コンポーネントは、sgcNavigation に含まれ、単体、または sgcUI Standard 以上で販売されます。All-Access 体験版には、評価用に sgcUI の全製品が含まれます。

最もお得な選択: All-AccesseSeGeCe の全製品にプレミアムサポートが付いて、年間 €1,059 からご利用いただけます。
All-Access の価格を見る

Delphi アプリケーションに通知を追加

sgcUI の体験版をダウンロードして、トースト、受信トレイ、バッジをご自身の IDE でお試しください。