C# アプリからローカル トースト通知を送信する

ユーザーが通知をクリックすると (またはフォアグラウンドアクティブ化を使用した通知のボタン)、アプリの App.xaml.cs OnActivated が呼び出され、追加した引数が返されます。

App.xaml.cs

protected override void OnActivated(IActivatedEventArgs e)
{
    // Handle notification activation
    if (e is ToastNotificationActivatedEventArgs toastActivationArgs)
    {
        // Obtain the arguments from the notification
        ToastArguments args = ToastArguments.Parse(toastActivationArgs.Argument);

        // Obtain any user input (text boxes, menu selections) from the notification
        ValueSet userInput = toastActivationArgs.UserInput;
 
        // TODO: Show the corresponding content
    }
}

まず、Package.appxmanifest で以下を追加します。

1. xmlns:com の 宣言
2. xmlns:desktop の 宣言
3. IgnorableNamespaces 属性では、com とデスクトップ
4. トースト アクティベーター CLSID (任意の新しい GUID を使用) を宣言するための、windows.toastNotificationActivation の desktop:Extension
5. MSIX のみ: COM アクティベーターの com:Extension (手順 4 の GUID を使用)。 通知から起動されたことがわかるように、必ず Arguments="-ToastActivated" を含めます

Package.appxmanifest

<!--Add these namespaces-->
<Package
  ...
  xmlns:com="http://schemas.microsoft.com/appx/manifest/com/windows10"
  xmlns:desktop="http://schemas.microsoft.com/appx/manifest/desktop/windows10"
  IgnorableNamespaces="... com desktop">
  ...
  <Applications>
    <Application>
      ...
      <Extensions>

        <!--Specify which CLSID to activate when toast clicked-->
        <desktop:Extension Category="windows.toastNotificationActivation">
          <desktop:ToastNotificationActivation ToastActivatorCLSID="replaced-with-your-guid-C173E6ADF0C3" /> 
        </desktop:Extension>

        <!--Register COM CLSID LocalServer32 registry key-->
        <com:Extension Category="windows.comServer">
          <com:ComServer>
            <com:ExeServer Executable="YourProject\YourProject.exe" Arguments="-ToastActivated" DisplayName="Toast activator">
              <com:Class Id="replaced-with-your-guid-C173E6ADF0C3" DisplayName="Toast activator"/>
            </com:ExeServer>
          </com:ComServer>
        </com:Extension>

      </Extensions>
    </Application>
  </Applications>
 </Package>

次に、アプリのスタートアップ コード (WPF の場合、App.xaml.cs OnStartup) で、OnActivated イベントをサブスクライブします。

// Listen to notification activation
ToastNotificationManagerCompat.OnActivated += toastArgs =>
{
    // Obtain the arguments from the notification
    ToastArguments args = ToastArguments.Parse(toastArgs.Argument);

    // Obtain any user input (text boxes, menu selections) from the notification
    ValueSet userInput = toastArgs.UserInput;

    // Need to dispatch to UI thread if performing UI operations
    Application.Current.Dispatcher.Invoke(delegate
    {
        // TODO: Show the corresponding content
        MessageBox.Show("Toast activated. Args: " + toastArgs.Argument);
    });
};

ユーザーが通知 (または通知のボタン) をクリックすると、次の処理が行われます。

アプリが現在実行されている場合

1. バックグラウンド スレッドで ToastNotificationManagerCompat.OnActivated イベントが呼び出されます。

アプリが現在閉じられている場合

1. アプリの EXE が起動され、ToastNotificationManagerCompat.WasCurrentProcessToastActivated() から true が返されます。これは、最新のアクティブ化によってプロセスが開始されたこと、およびイベント ハンドラーが間もなく呼び出されることを示しています。
2. 次に、バックグラウンド スレッドで ToastNotificationManagerCompat.OnActivated イベントが呼び出されます。

ユーザーが通知 (または通知のボタン) をクリックすると、次の処理が行われます。

アプリが現在実行されている場合

1. バックグラウンド スレッドで ToastNotificationManagerCompat.OnActivated イベントが呼び出されます。

アプリが現在閉じられている場合

1. アプリの EXE が起動され、ToastNotificationManagerCompat.WasCurrentProcessToastActivated() から true が返されます。これは、最新のアクティブ化によってプロセスが開始されたこと、およびイベント ハンドラーが間もなく呼び出されることを示しています。
2. 次に、バックグラウンド スレッドで ToastNotificationManagerCompat.OnActivated イベントが呼び出されます。

アプリのスタートアップ コード (WPF の場合、App.xaml.cs OnStartup) で、OnActivated イベントをサブスクライブします。

// Listen to notification activation
ToastNotificationManagerCompat.OnActivated += toastArgs =>
{
    // Obtain the arguments from the notification
    ToastArguments args = ToastArguments.Parse(toastArgs.Argument);

    // Obtain any user input (text boxes, menu selections) from the notification
    ValueSet userInput = toastArgs.UserInput;

    // Need to dispatch to UI thread if performing UI operations
    Application.Current.Dispatcher.Invoke(delegate
    {
        // TODO: Show the corresponding content
        MessageBox.Show("Toast activated. Args: " + toastArgs.Argument);
    });
};

何も行う必要はありません。 UWP アプリがアンインストールされると、すべての通知とその他の関連リソースが自動的にクリーンアップされます。

何も行う必要はありません。 MSIX アプリがアンインストールされると、すべての通知とその他の関連リソースが自動的にクリーンアップされます。

アプリにアンインストーラーがある場合は、アンインストーラーで ToastNotificationManagerCompat.Uninstall(); を呼び出す必要があります。 アプリがインストーラーのない "ポータブル アプリ" の場合は、アプリを閉じた後も継続される通知がない限り、アプリの終了時にこのメソッドを呼び出すことを検討してください。

アンインストール メソッドにより、スケジュールされた通知と現在の通知がクリーンアップされ、関連するレジストリ値が削除されます。また、ライブラリによって作成された関連する一時ファイルも削除されます。

トースト (またはトースト内のボタン) でバックグラウンドアクティブ化を指定すると、フォアグラウンド アプリをアクティブ化するのではなく、バックグラウンド タスクが実行されます。

バックグラウンド タスクの詳細については、「 バックグラウンド タスクを使用してアプリをサポートする」を参照してください。

ビルド 14393 以降を対象としている場合は、インプロセスバックグラウンド タスクを使用できるため、処理が大幅に簡略化されます。 インプロセス バックグラウンド タスクは、古いバージョンの Windows では実行できません。 このコード サンプルでは、インプロセス バックグラウンド タスクを使用します。

const string taskName = "ToastBackgroundTask";

// If background task is already registered, do nothing
if (BackgroundTaskRegistration.AllTasks.Any(i => i.Value.Name.Equals(taskName)))
    return;

// Otherwise request access
BackgroundAccessStatus status = await BackgroundExecutionManager.RequestAccessAsync();

// Create the background task
BackgroundTaskBuilder builder = new BackgroundTaskBuilder()
{
    Name = taskName
};

// Assign the toast action trigger
builder.SetTrigger(new ToastNotificationActionTrigger());

// And register the task
BackgroundTaskRegistration registration = builder.Register();

次に、App.xaml.cs で OnBackgroundActivated メソッドをオーバーライドします。 その後、フォアグラウンドのアクティブ化と同様に、事前定義済みの引数とユーザー入力を取得できます。

App.xaml.cs

protected override async void OnBackgroundActivated(BackgroundActivatedEventArgs args)
{
    var deferral = args.TaskInstance.GetDeferral();
 
    switch (args.TaskInstance.Task.Name)
    {
        case "ToastBackgroundTask":
            var details = args.TaskInstance.TriggerDetails as ToastNotificationActionTriggerDetail;
            if (details != null)
            {
                ToastArguments arguments = ToastArguments.Parse(details.Argument);
                var userInput = details.UserInput;

                // Perform tasks
            }
            break;
    }
 
    deferral.Complete();
}

デスクトップ アプリケーションの場合、バックグラウンドのアクティブ化はフォアグラウンドのアクティブ化と同様に処理されます (OnActivated イベント ハンドラーがトリガーされます)。 アクティブ化を処理した後、UI を表示せずに、アプリを閉じることもできます。