Azure Notification Hubs を使用してクロスプラットフォーム通知を送信する

[アーティクル]
06/01/2023

このチュートリアルは、前のチュートリアル「Azure Notification Hubs を使用して特定のユーザーに通知を送信する」に基づいています。そのチュートリアルでは、認証された特定のユーザーに登録されているすべてのデバイスにプッシュ通知を行う方法について説明しました。その方法では、サポートされる各クライアントプラットフォームに通知を送信するため、複数の要求が必要でした。 Azure Notification Hubs ではテンプレートがサポートされています。テンプレートを使用して、特定のデバイスが通知を受信する方法を指定できます。この方法により、クロスプラットフォーム通知の送信が簡単になります。

この記事では、テンプレートを活用して、すべてのプラットフォームをターゲットとする通知を送信する方法を示します。この記事では、単一の要求を使用して、プラットフォームに依存しない通知を送信します。テンプレートの詳細については、「Notification Hubs の概要」を参照してください。

重要

Visual Studio 2019 では、Windows Phone 8.1 以前のプロジェクトはサポートされていません。詳細については、「Visual Studio 2019 の対象プラットフォームと互換性」を参照してください。

注意

Notification Hubs では、デバイスが同じタグを使用して複数のテンプレートを登録できます。この場合、そのタグをターゲットとするメッセージが受信されると複数の通知がデバイスに配信されます (テンプレートごとに 1 つずつ)。このプロセスにより、複数のビジュアル通知に同じメッセージを表示することが可能になります (Windows ストアアプリでバッジとトースト通知の両方として表示するなど)。により、複数のビジュアル通知に同じメッセージを表示することが可能になります (Windows ストアアプリでバッジとトースト通知の両方として表示するなど)。

テンプレートを使用したクロスプラットフォーム通知の送信

注意

Microsoft プッシュ通知サービス (MPNS) は非推奨とされ、サポートされなくなりました。

このセクションでは、「Azure Notification Hubs を使用して特定のユーザーに通知を送信する」で作成したサンプルコードを使用します。 GitHub から完全なサンプルをダウンロードすることができます。

テンプレートを使用してクロスプラットフォーム通知を送信するには、次の手順を実行します。

Visual Studio のソリューションエクスプローラーで、Controllers フォルダーを展開して、RegisterController.cs ファイルを開きます。

Put メソッドで新しい登録を作成するコードブロックを検索し、switch の内容を次のコードに置き換えます。

switch (deviceUpdate.Platform)
{
    case "mpns":
        var toastTemplate = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" +
            "<wp:Notification xmlns:wp=\"WPNotification\">" +
                "<wp:Toast>" +
                    "<wp:Text1>$(message)</wp:Text1>" +
                "</wp:Toast> " +
            "</wp:Notification>";
        registration = new MpnsTemplateRegistrationDescription(deviceUpdate.Handle, toastTemplate);
        break;
    case "wns":
        toastTemplate = @"<toast><visual><binding template=""ToastText01""><text id=""1"">$(message)</text></binding></visual></toast>";
        registration = new WindowsTemplateRegistrationDescription(deviceUpdate.Handle, toastTemplate);
        break;
    case "apns":
        var alertTemplate = "{\"aps\":{\"alert\":\"$(message)\"}}";
        registration = new AppleTemplateRegistrationDescription(deviceUpdate.Handle, alertTemplate);
        break;
    case "fcm":
        var messageTemplate = "{\"data\":{\"message\":\"$(message)\"}}";
        registration = new FcmTemplateRegistrationDescription(deviceUpdate.Handle, messageTemplate);
        break;
    default:
        throw new HttpResponseException(HttpStatusCode.BadRequest);
}

このコードは、プラットフォーム固有のメソッドを呼び出して、ネイティブ登録の代わりにテンプレート登録を作成します。テンプレート登録はネイティブ登録から派生しているため、既存の登録を変更する必要はありません。

ソリューションエクスプローラーで Controllers フォルダーを展開し、NotificationsController.cs ファイルを開きます。 Post メソッドを次のコードに置き換えます。
```
public async Task<HttpResponseMessage> Post()
{
    var user = HttpContext.Current.User.Identity.Name;
    var userTag = "username:" + user;

    var notification = new Dictionary<string, string> { { "message", "Hello, " + user } };
    await Notifications.Instance.Hub.SendTemplateNotificationAsync(notification, userTag);

    return Request.CreateResponse(HttpStatusCode.OK);
}
```
このコードでは、すべてのプラットフォームに同時に通知が送信されます。ネイティブペイロードは指定してません。 Notification Hubs では、登録したテンプレートでの指定内容に従って、提供されたタグ値を使用して適切なペイロードが作成され各デバイスに配信されます。
ご利用の Web API プロジェクトを再発行します。
もう一度クライアントアプリケーションを実行して、登録に成功したことを確認します。
必要に応じて、クライアントアプリケーションを 2 つ目のデバイスにデプロイしてから、アプリケーションを実行します。通知が各デバイスに表示されます。

次のステップ

このチュートリアルはこれで終了です。Notification Hubs とテンプレートの詳細については、次の記事を参照してください。

テンプレートを使用する場合の別のシナリオについては、ユニバーサル Windows プラットフォームアプリケーションを実行している特定の Windows デバイスへのプッシュ通知の送信に関するチュートリアルを参照してください。
テンプレートの詳細については、「Azure Notification Hubs の概要」を参照してください。

Azure Notification Hubs を使用してクロスプラットフォーム通知を送信する

テンプレートを使用したクロスプラットフォーム通知の送信

次のステップ

その他のリソース