Tutoriel : Envoyer des notifications Push aux applications Xamarin.Forms à l’aide d’Azure Notification Hubs via un service back-end

Article
07/27/2020

Dans ce tutoriel, vous utilisez Azure Notification Hubs pour envoyer des notifications push à une application Xamarin.Forms ciblant Android et iOS.

Un back-end d’API web ASP.NET Core est utilisé pour gérer l’inscription des appareils pour le client à l’aide de l’approche d’installation la plus récente et la meilleure. Le service envoie également des notifications Push de manière multiplateforme.

Ces opérations sont gérées à l’aide du Kit de développement logiciel (SDK) Notification Hubs pour les opérations back-end. Pour plus d’informations sur l’approche globale, consultez la documentation Inscription à partir de votre back-end d’application .

Ce tutoriel vous guide tout au long des étapes suivantes :

Configurez Push Notification Services et Azure Notification Hubs.
Créez une application principale d’API web ASP.NET Core.
Créez une application Xamarin.Forms multiplateforme.
Configurez le projet Android natif pour les notifications Push.
Configurez le projet iOS natif pour les notifications Push.
Testez la solution.

Prérequis

Pour suivre, vous avez besoin des éléments suivants :

Un abonnement Azure dans lequel vous pouvez créer et gérer des ressources.
Un Mac avec Visual Studio pour Mac installé ou un PC exécutant Visual Studio 2019.
Les utilisateurs de Visual Studio 2019 doivent également disposer du développement mobile avec .NET et des charges de travail de développement ASP.NET et web installées.
Possibilité d’exécuter l’application sur Android (appareils physiques ou émulateurs) ou iOS (appareils physiques uniquement).

Pour Android, vous devez disposer des éléments suivants :

Un développeur a déverrouillé un appareil physique ou un émulateur (exécutant l’API 26 et ultérieure avec google Play Services installés).

Pour iOS, vous devez disposer des éléments suivants :

Un compte de développeur Apple actif.
Un appareil iOS physique inscrit à votre compte de développeur(exécutant iOS 13.0 et versions ultérieures).
Un certificat de développement.p12 installé dans votre keychain vous permettant d’exécuter une application sur un appareil physique.

Notes

Le simulateur iOS ne prend pas en charge les notifications à distance. Par conséquent, un appareil physique est requis lors de l’exploration de cet exemple sur iOS. Toutefois, vous n’avez pas besoin d’exécuter l’application sur Android et iOS pour suivre ce tutoriel.

Vous pouvez suivre les étapes de cet exemple de premier principe sans expérience préalable. Toutefois, vous aurez avantage à vous familiariser avec les aspects suivants.

Important

Les étapes fournies sont spécifiques à Visual Studio pour Mac. Il est possible de suivre à l’aide de Visual Studio 2019 , mais il peut y avoir quelques différences à concilier. Par exemple, des descriptions de l’interface utilisateur et des workflows, des noms de modèles, de la configuration de l’environnement, etc.

Configurer Push Notification Services et Azure Notification Hub

Dans cette section, vous allez configurer Firebase Cloud Messaging (FCM) et Apple Push Notification Services (APNS). Vous créez et configurez ensuite un hub de notification pour qu’il fonctionne avec ces services.

Créer un projet Firebase et activer Firebase Cloud Messaging pour Android

Connectez-vous à la console Firebase. Créez un projet Firebase en entrant PushDemo comme nom du projet.

Notes

Un nom unique sera généré pour vous. Par défaut, il s’agit d’une variante en minuscules du nom que vous avez fourni et d’un nombre généré séparé par un tiret. Vous pouvez le modifier si vous le souhaitez, à condition qu’il reste globalement unique.
Après avoir créé votre projet, sélectionnez Ajouter Firebase à votre application Android.
Dans la page Ajouter Firebase à votre application Android , effectuez les étapes suivantes.
1. Pour le nom du package Android, entrez un nom pour votre package. Par exemple : com.<organization_identifier>.<package_name>.
2. Sélectionnez Inscrire une application.
3. Sélectionnez Télécharger google-services.json. Enregistrez ensuite le fichier dans un dossier local pour une utilisation ultérieure, puis sélectionnez Suivant.
4. Sélectionnez Suivant.
5. Sélectionnez Continuer vers la console
  
  Notes
  
  Si le bouton Continuer vers la console n’est pas activé, en raison de l’case activée vérifier l’installation, choisissez Ignorer cette étape.
Dans la console Firebase, sélectionnez l’engrenage de votre projet. Sélectionnez ensuite Paramètres du projet.

Notes

Si vous n’avez pas téléchargé le fichier google-services.json , vous pouvez le télécharger sur cette page.
Basculez vers l’onglet Cloud Messaging en haut. Copiez et enregistrez la clé de serveur pour une utilisation ultérieure. Vous utilisez cette valeur pour configurer votre hub de notification.

Inscrire votre application iOS pour les notifications Push

Pour envoyer des notifications Push à une application iOS, inscrivez votre application auprès d’Apple et inscrivez-vous également aux notifications Push.

Si vous n’avez pas encore inscrit votre application, accédez au portail d’approvisionnement iOS dans le Centre de développement Apple. Connectez-vous au portail avec votre ID Apple, accédez à Certificats, Identificateurs & Profils, puis sélectionnez Identificateurs. Cliquez + pour inscrire une nouvelle application.
Dans l’écran Inscrire un nouvel identificateur , sélectionnez la case d’option ID d’application . Sélectionnez ensuite Continuer.
Mettez à jour les trois valeurs suivantes pour votre nouvelle application, puis sélectionnez Continuer :
- Description : tapez un nom descriptif pour votre application.
- ID de bundle : entrez un ID d’offre groupée au format com.organization_identifier<>.<>product_name comme indiqué dans le Guide de distribution des applications. Dans la capture d’écran suivante, la mobcat valeur est utilisée comme identificateur de organization et la valeur PushDemo est utilisée comme nom de produit.
- Notifications Push : cochez l’option Notifications Push dans la section Fonctionnalités .
  
  Cette action génère votre ID d’application et vous demande de confirmer les informations. Sélectionnez Continuer, puis s’inscrire pour confirmer le nouvel ID d’application.
  
  Après avoir sélectionné Inscrire, vous voyez le nouvel ID d’application comme élément de ligne dans la page Certificats, identificateurs & profils .
Dans la page Certificats, identificateurs & profils , sous Identificateurs, recherchez l’élément de ligne ID d’application que vous avez créé. Sélectionnez ensuite sa ligne pour afficher l’écran Modifier la configuration de votre ID d’application .

Création d’un certificat pour Notification Hubs

Un certificat est requis pour permettre au hub de notification de fonctionner avec Apple Push Notification Services (APNS) et peut être fourni de deux façons :

Création d’un certificat Push p12 qui peut être chargé directement sur Notification Hub (approche d’origine)
Création d’un certificat p8 qui peut être utilisé pour l’authentification basée sur les jetons (approche plus récente et recommandée)

Cette approche plus récente présente un certain nombre d’avantages, comme indiqué dans l’authentification basée sur des jetons (HTTP/2) pour APNS. Moins d’étapes sont requises, mais sont également obligatoires pour des scénarios spécifiques. Toutefois, des étapes ont été fournies pour les deux approches, car l’une ou l’autre fonctionne dans le cadre de ce didacticiel.

OPTION 1 : Création d’un certificat Push p12 qui peut être chargé directement sur Notification Hub

Sur votre Mac, exécutez l’outil d’accès au trousseau. Il peut être ouvert à partir du dossier Utilitaires ou du dossier Autre du Launchpad.
Sélectionnez Accès au trousseau, développez Assistant Certificat, puis sélectionnez Demander un certificat auprès d’une autorité de certification.

Notes

Par défaut, Keychain Access sélectionne le premier élément de la liste. Cela peut être un problème si vous êtes dans la catégorie Certificats et que l’autorité de certification Apple Worldwide Developer Relations n’est pas le premier élément de la liste. Vérifiez que vous disposez d’un élément non clé ou que la clé d’autorité de certification Apple Worldwide Developer Relations est sélectionnée avant de générer la demande de signature de certificat (CSR).
Sélectionnez votre adresse de Email d’utilisateur, entrez votre valeur Nom commun, assurez-vous que vous spécifiez Enregistré sur le disque, puis sélectionnez Continuer. Laissez l’adresse Email de l’autorité de certification vide, car elle n’est pas nécessaire.
Entrez un nom pour le fichier demande de signature de certificat (CSR) dans Enregistrer sous, sélectionnez l’emplacement dans Où, puis sélectionnez Enregistrer.

Cette action enregistre le fichier CSR à l’emplacement sélectionné. L’emplacement par défaut est Desktop. N’oubliez pas l’emplacement choisi pour le fichier.
Dans la page Certificats, identificateurs & profils du portail d’approvisionnement iOS, faites défiler jusqu’à l’option Notifications Push cochée, puis sélectionnez Configurer pour créer le certificat.
La fenêtre Certificats TLS/SSL du service de notification Push Apple s’affiche. Sélectionnez le bouton Créer un certificat sous la section Certificat TLS/SSL de développement .

L’écran Créer un certificat s’affiche.

Notes

Ce tutoriel utilise un certificat de développement. Le même processus est utilisé lors de l’inscription d’un certificat de production. Veillez simplement à utiliser le même type de certificat lors de l’envoi de notifications.
Sélectionnez Choisir un fichier, accédez à l’emplacement où vous avez enregistré le fichier CSR, puis double-cliquez sur le nom du certificat pour le charger. Sélectionnez ensuite Continuer.
Une fois que le portail a créé le certificat, sélectionnez le bouton Télécharger . Enregistrez le certificat et mémorisez l’emplacement où il est enregistré.

Le certificat est téléchargé et enregistré sur votre ordinateur dans votre dossier Téléchargements .

Notes

Par défaut, le certificat de développement téléchargé est nommé aps_development.cer.
Double-cliquez sur le certificat Push téléchargé aps_development.cer. Cette action installe le nouveau certificat dans le trousseau, comme illustré dans l’image suivante :

Notes

Bien que le nom de votre certificat puisse être différent, le nom est préfixé par Apple Development iOS Push Services et l’identificateur de bundle approprié est associé.
Dans Accès au trousseau, Contrôle + Cliquez sur le nouveau certificat push que vous avez créé dans la catégorie Certificats . Sélectionnez Exporter, nommez le fichier, sélectionnez le format p12 , puis sélectionnez Enregistrer.

Vous pouvez choisir de protéger le certificat avec un mot de passe, mais un mot de passe est facultatif. Cliquez sur OK si vous souhaitez ignorer la création du mot de passe. Notez le nom de fichier et l’emplacement du certificat p12 exporté. Ils sont utilisés pour activer l’authentification avec les APN.

Notes

Le nom et l’emplacement de votre fichier p12 peuvent être différents de ce qui est illustré dans ce tutoriel.

OPTION 2 : Création d’un certificat p8 qui peut être utilisé pour l’authentification basée sur les jetons

Notez les détails suivants :
- Préfixe d’ID d’application (ID d’équipe)
- ID d’offre groupée
De retour dans Certificats, identificateurs & profils, cliquez sur Clés.

Notes

Si vous avez déjà configuré une clé pour APNS, vous pouvez réutiliser le certificat p8 que vous avez téléchargé juste après sa création. Dans ce cas, vous pouvez ignorer les étapes 3 à 5.
Cliquez sur le + bouton (ou sur le bouton Créer une clé ) pour créer une nouvelle clé.
Fournissez une valeur de nom de clé appropriée, puis case activée l’option APNS (Apple Push Notifications Service), puis cliquez sur Continuer, puis sur Inscrire sur l’écran suivant.
Cliquez sur Télécharger , puis déplacez le fichier p8 (préfixé par AuthKey_) vers un répertoire local sécurisé, puis cliquez sur Terminé.

Notes

Veillez à conserver votre fichier p8 dans un endroit sécurisé (et à enregistrer une sauvegarde). Après avoir téléchargé votre clé, elle ne peut pas être téléchargée à nouveau, car la copie du serveur est supprimée.
Sur Clés, cliquez sur la clé que vous avez créée (ou sur une clé existante si vous avez choisi de l’utiliser à la place).
Notez la valeur de l’ID de clé .
Ouvrez votre certificat p8 dans une application appropriée de votre choix, telle que Visual Studio Code. Notez la valeur de la clé (entre -----BEGIN PRIVATE KEY----- et -----END PRIVATE KEY-----).

-----BEGIN PRIVATE KEY-----
<key_value>
-----END PRIVATE KEY-----

Notes

Il s’agit de la valeur de jeton qui sera utilisée ultérieurement pour configurer Notification Hub.

À la fin de ces étapes, vous devez disposer des informations suivantes pour une utilisation ultérieure dans Configurer votre hub de notification avec les informations APNS :

ID d’équipe (voir l’étape 1)
ID de bundle (voir étape 1)
ID de clé (voir l’étape 7)
Valeur de jeton (valeur de clé p8 obtenue à l’étape 8)

Créer un profil d’approvisionnement pour l’application

Revenez au portail d’approvisionnement iOS, sélectionnez Certificats, Identificateurs & Profils, Sélectionnez Profils dans le menu de gauche, puis sélectionnez + pour créer un profil. L’écran Inscrire un nouveau profil d’approvisionnement s’affiche.
Sélectionnez Développement d’applications iOS sous Développement comme type de profil d’approvisionnement, puis sélectionnez Continuer.
Ensuite, sélectionnez l’ID d’application que vous avez créé dans la liste déroulante ID d’application , puis sélectionnez Continuer.
Dans la fenêtre Sélectionner des certificats , sélectionnez le certificat de développement que vous utilisez pour la signature de code, puis sélectionnez Continuer.

Notes

Ce certificat n’est pas le certificat push que vous avez créé à l’étape précédente. Il s’agit de votre certificat de développement. S’il n’en existe pas, vous devez le créer, car il s’agit d’un prérequis pour ce didacticiel. Les certificats de développeur peuvent être créés dans le portail des développeurs Apple, via Xcode ou dans Visual Studio.
Revenez à la page Certificats, Identificateurs & Profils , sélectionnez Profils dans le menu de gauche, puis sélectionnez + pour créer un profil. L’écran Inscrire un nouveau profil d’approvisionnement s’affiche.
Dans la fenêtre Sélectionner des certificats , sélectionnez le certificat de développement que vous avez créé. Sélectionnez ensuite Continuer.
Ensuite, sélectionnez les appareils à utiliser pour le test, puis sélectionnez Continuer.
Enfin, choisissez un nom pour le profil dans Nom du profil d’approvisionnement, puis sélectionnez Générer.
Lorsque le nouveau profil d’approvisionnement est créé, sélectionnez Télécharger. N’oubliez pas l’emplacement dans lequel il est enregistré.
Accédez à l’emplacement du profil d’approvisionnement, puis double-cliquez dessus pour l’installer sur votre ordinateur de développement.

Créer un hub de notification

Dans cette section, vous allez créer un hub de notification et configurer l’authentification avec APNS. Vous pouvez utiliser un certificat push p12 ou une authentification basée sur des jetons. Si vous souhaitez utiliser un hub de notification que vous avez déjà créé, vous pouvez passer à l’étape 5.

Connectez-vous à Azure.
Cliquez sur Créer une ressource, recherchez et choisissez Notification Hub, puis cliquez sur Créer.
Mettez à jour les champs suivants, puis cliquez sur Créer :

DÉTAILS DE BASE

Abonnement: Choisissez l’abonnement cible dans la liste déroulante
Groupe de ressources : Créer un groupe de ressources (ou en choisir un existant)

DÉTAILS DE L’ESPACE DE NOMS

Espace de noms Du hub de notification : Entrez un nom global unique pour l’espace de noms Notification Hub

Notes

Vérifiez que l’option Créer un nouveau est sélectionnée pour ce champ.

DÉTAILS DU HUB DE NOTIFICATION

Hub de notification : Entrez un nom pour le hub de notification
Emplacement: Choisir un emplacement approprié dans la liste déroulante
Niveau tarifaire : Conserver l’option Gratuit par défaut

Notes

Sauf si vous avez atteint le nombre maximal de hubs sur le niveau gratuit.
Une fois que le hub de notification a été provisionné, accédez à cette ressource.
Accédez à votre nouveau hub de notification.
Sélectionnez Stratégies d’accès dans la liste (sous GÉRER).
Notez les valeurs Nom de la stratégie ainsi que leurs valeurs de chaîne de connexion correspondantes .

Configurer votre hub de notification avec les informations APNS

Sous Notification Services, sélectionnez Apple , puis suivez les étapes appropriées en fonction de l’approche que vous avez choisie précédemment dans la section Création d’un certificat pour Notification Hubs .

Notes

Utilisez le mode Production pour application uniquement si vous souhaitez envoyer des notifications Push aux utilisateurs qui ont acheté votre application à partir du Store.

OPTION 1 : Utilisation d’un certificat push .p12

Sélectionnez Certificat.
Sélectionnez l’icône de fichier.
Sélectionnez le fichier .p12 que vous avez exporté précédemment, puis sélectionnez Ouvrir.
Si nécessaire, spécifiez le mot de passe correct.
Sélectionnez Mode bac à sable .
Sélectionnez Enregistrer.

OPTION 2 : Utilisation de l’authentification basée sur les jetons

Sélectionnez Jeton.
Entrez les valeurs suivantes que vous avez acquises précédemment :
- ID de clé
- ID d’offre groupée
- ID d’équipe
- Jeton
Choisissez Bac à sable.
Sélectionnez Enregistrer.

Configurer votre hub de notification avec des informations FCM

Sélectionnez Google (GCM/FCM) dans la section Paramètres du menu de gauche.
Entrez la clé de serveur que vous avez notée à partir de la console Google Firebase.
Sélectionnez Enregistrer dans la barre d’outils.

Créer une application principale d’API web ASP.NET Core

Dans cette section, vous allez créer le back-end d’API web ASP.NET Core pour gérer l’inscription de l’appareil et l’envoi de notifications à l’application mobile Xamarin.Forms.

Créer un projet web

Dans Visual Studio, sélectionnez Fichier>Nouvelle solution.
SélectionnezApplication>.NET Core>ASP.NET Core>API>Suivant.
Dans la boîte de dialogue Configurer votre nouvelle API web ASP.NET Core, sélectionnez Framework cible de .NET Core 3.1.
Entrez PushDemoApi comme nom du projet , puis sélectionnez Créer.
Démarrez le débogage (Entrée de commande + ) pour tester l’application modèle.
Notes

L’application modèle est configurée pour utiliser WeatherForecastController comme launchUrl. Cette valeur est définie dans Propriétés>launchSettings.json.

Si vous êtes invité à fournir un certificat de développement non valide, message trouvé :
1. Cliquez sur Oui pour accepter d’exécuter l’outil « dotnet dev-certs https » pour résoudre ce problème. L’outil « dotnet dev-certs https » vous invite ensuite à entrer un mot de passe pour le certificat et le mot de passe de votre trousseau.
2. Cliquez sur Oui lorsque vous êtes invité à installer et à approuver le nouveau certificat, puis entrez le mot de passe de votre trousseau.
Développez le dossier Contrôleurs , puis supprimez WeatherForecastController.cs.
Supprimez WeatherForecast.cs.
Configurez des valeurs de configuration locales à l’aide de l’outil Gestionnaire de secrets. Le découplage des secrets de la solution garantit qu’ils ne se retrouvent pas dans le contrôle de code source. Ouvrez Terminal , puis accédez au répertoire du fichier projet et exécutez les commandes suivantes :
```
dotnet user-secrets init
dotnet user-secrets set "NotificationHub:Name" <value>
dotnet user-secrets set "NotificationHub:ConnectionString" <value>
```
Remplacez les valeurs d’espace réservé par votre propre nom de hub de notification et chaîne de connexion valeurs. Vous en avez pris note dans la section Créer un hub de notification . Sinon, vous pouvez les rechercher dans Azure.

NotificationHub :Name :
Consultez Nom dans le résumé Essentials en haut de Vue d’ensemble.

NotificationHub :ConnectionString :
Consultez DefaultFullSharedAccessSignature dans stratégies d’accès

Notes

Pour les scénarios de production, vous pouvez examiner des options telles qu’Azure KeyVault pour stocker de manière sécurisée les chaîne de connexion. Par souci de simplicité, les secrets seront ajoutés aux paramètres de l’application Azure App Service.

Authentifier les clients à l’aide d’une clé API (facultatif)

Les clés API ne sont pas aussi sécurisées que les jetons, mais elles suffisent pour les besoins de ce didacticiel. Une clé API peut être configurée facilement via l’intergiciel ASP.NET.

Ajoutez la clé API aux valeurs de configuration locales.
```
dotnet user-secrets set "Authentication:ApiKey" <value>
```
Notes

Vous devez remplacer la valeur de l’espace réservé par la vôtre et en prendre note.
Contrôle + Cliquez sur le projet PushDemoApi , choisissez Nouveau dossier dans le menu Ajouter , puis cliquez sur Ajouter à l’aide de l’authentification comme nom de dossier.
Contrôle + Cliquez sur le dossier Authentification , puis choisissez Nouveau fichier... dans le menu Ajouter .

Sélectionnez Classe vide générale>, entrez ApiKeyAuthOptions.cs pour le nom, puis cliquez sur Nouveau en ajoutant l’implémentation suivante.

using Microsoft.AspNetCore.Authentication;

namespace PushDemoApi.Authentication
{
    public class ApiKeyAuthOptions : AuthenticationSchemeOptions
    {
        public const string DefaultScheme = "ApiKey";
        public string Scheme => DefaultScheme;
        public string ApiKey { get; set; }
    }
}

Ajoutez une autre classe vide au dossier d’authentification appelé ApiKeyAuthHandler.cs, puis ajoutez l’implémentation suivante.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Security.Claims;
using System.Text.Encodings.Web;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Authentication;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;

namespace PushDemoApi.Authentication
{
    public class ApiKeyAuthHandler : AuthenticationHandler<ApiKeyAuthOptions>
    {
        const string ApiKeyIdentifier = "apikey";

        public ApiKeyAuthHandler(
            IOptionsMonitor<ApiKeyAuthOptions> options,
            ILoggerFactory logger,
            UrlEncoder encoder,
            ISystemClock clock)
            : base(options, logger, encoder, clock) {}

        protected override Task<AuthenticateResult> HandleAuthenticateAsync()
        {
            string key = string.Empty;

            if (Request.Headers[ApiKeyIdentifier].Any())
            {
                key = Request.Headers[ApiKeyIdentifier].FirstOrDefault();
            }
            else if (Request.Query.ContainsKey(ApiKeyIdentifier))
            {
                if (Request.Query.TryGetValue(ApiKeyIdentifier, out var queryKey))
                    key = queryKey;
            }

            if (string.IsNullOrWhiteSpace(key))
                return Task.FromResult(AuthenticateResult.Fail("No api key provided"));

            if (!string.Equals(key, Options.ApiKey, StringComparison.Ordinal))
                return Task.FromResult(AuthenticateResult.Fail("Invalid api key."));

            var identities = new List<ClaimsIdentity> {
                new ClaimsIdentity("ApiKeyIdentity")
            };

            var ticket = new AuthenticationTicket(
                new ClaimsPrincipal(identities), Options.Scheme);

            return Task.FromResult(AuthenticateResult.Success(ticket));
        }
    }
}

Notes

Un gestionnaire d’authentification est un type qui implémente le comportement d’un schéma, dans ce cas un schéma de clé API personnalisé.

Ajoutez une autre classe vide au dossier d’authentification appelé ApiKeyAuthenticationBuilderExtensions.cs, puis ajoutez l’implémentation suivante.

using System;
using Microsoft.AspNetCore.Authentication;

namespace PushDemoApi.Authentication
{
    public static class AuthenticationBuilderExtensions
    {
        public static AuthenticationBuilder AddApiKeyAuth(
            this AuthenticationBuilder builder,
            Action<ApiKeyAuthOptions> configureOptions)
        {
            return builder
                .AddScheme<ApiKeyAuthOptions, ApiKeyAuthHandler>(
                    ApiKeyAuthOptions.DefaultScheme,
                    configureOptions);
        }
    }
}

Notes

Cette méthode d’extension simplifie le code de configuration du middleware dans Startup.cs le rendant plus lisible et généralement plus facile à suivre.

Dans Startup.cs, mettez à jour la méthode ConfigureServices pour configurer l’authentification par clé API sous l’appel aux services. Méthode AddControllers .

using PushDemoApi.Authentication;
using PushDemoApi.Models;
using PushDemoApi.Services;

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers();

    services.AddAuthentication(options =>
    {
        options.DefaultAuthenticateScheme = ApiKeyAuthOptions.DefaultScheme;
        options.DefaultChallengeScheme = ApiKeyAuthOptions.DefaultScheme;
    }).AddApiKeyAuth(Configuration.GetSection("Authentication").Bind);
}

Toujours dans Startup.cs, mettez à jour la méthode Configure pour appeler les méthodes d’extension UseAuthentication et UseAuthorization sur IApplicationBuilder de l’application. Assurez-vous que ces méthodes sont appelées après UseRouting et avant l’application. UtilisezEndpoints.
```
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }

    app.UseHttpsRedirection();

    app.UseRouting();

    app.UseAuthentication();

    app.UseAuthorization();

    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllers();
    });
}
```
Notes

L’appel à UseAuthentication inscrit le middleware qui utilise les schémas d’authentification précédemment inscrits (à partir de ConfigureServices). Cela doit être appelé avant tout intergiciel qui dépend de l’authentification des utilisateurs.

Ajouter des dépendances et configurer des services

ASP.NET Core prend en charge le modèle de conception de logiciel d’injection de dépendances (ID), qui est une technique permettant d’obtenir l’inversion de contrôle (IoC) entre les classes et leurs dépendances.

L’utilisation du hub de notification et du Kit de développement logiciel (SDK) Notification Hubs pour les opérations principales est encapsulée dans un service. Le service est inscrit et mis à disposition via une abstraction appropriée.

Contrôle + Cliquez sur le dossier Dépendances , puis choisissez Gérer les packages NuGet....
Recherchez Microsoft.Azure.NotificationHubs et vérifiez qu’il est vérifié.
Cliquez sur Ajouter des packages, puis cliquez sur Accepter lorsque vous êtes invité à accepter les termes du contrat de licence.
Contrôle + Cliquez sur le projet PushDemoApi , choisissez Nouveau dossier dans le menu Ajouter , puis cliquez sur Ajouter à l’aide de modèles comme nom de dossier.
Contrôle + Cliquez sur le dossier Modèles , puis choisissez Nouveau fichier... dans le menu Ajouter .

Sélectionnez Général>Classe vide, entrez PushTemplates.cs pour le nom, puis cliquez sur Nouveau en ajoutant l’implémentation suivante.

namespace PushDemoApi.Models
{
    public class PushTemplates
    {
        public class Generic
        {
            public const string Android = "{ \"notification\": { \"title\" : \"PushDemo\", \"body\" : \"$(alertMessage)\"}, \"data\" : { \"action\" : \"$(alertAction)\" } }";
            public const string iOS = "{ \"aps\" : {\"alert\" : \"$(alertMessage)\"}, \"action\" : \"$(alertAction)\" }";
        }

        public class Silent
        {
            public const string Android = "{ \"data\" : {\"message\" : \"$(alertMessage)\", \"action\" : \"$(alertAction)\"} }";
            public const string iOS = "{ \"aps\" : {\"content-available\" : 1, \"apns-priority\": 5, \"sound\" : \"\", \"badge\" : 0}, \"message\" : \"$(alertMessage)\", \"action\" : \"$(alertAction)\" }";
        }
    }
}

Notes

Cette classe contient les charges utiles de notification tokenisées pour les notifications génériques et silencieuses requises par ce scénario. Les charges utiles sont définies en dehors de l’installation pour permettre l’expérimentation sans avoir à mettre à jour les installations existantes via le service. La gestion des modifications apportées aux installations de cette manière est hors de portée pour ce tutoriel. Pour la production, envisagez des modèles personnalisés.

Ajoutez une autre classe vide au dossier Models appelé DeviceInstallation.cs, puis ajoutez l’implémentation suivante.

using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;

namespace PushDemoApi.Models
{
    public class DeviceInstallation
    {
        [Required]
        public string InstallationId { get; set; }

        [Required]
        public string Platform { get; set; }

        [Required]
        public string PushChannel { get; set; }

        public IList<string> Tags { get; set; } = Array.Empty<string>();
    }
}

Ajoutez une autre classe vide au dossier Models appelé NotificationRequest.cs, puis ajoutez l’implémentation suivante.

using System;

namespace PushDemoApi.Models
{
    public class NotificationRequest
    {
        public string Text { get; set; }
        public string Action { get; set; }
        public string[] Tags { get; set; } = Array.Empty<string>();
        public bool Silent { get; set; }
    }
}

Ajoutez une autre classe vide au dossier Models appelé NotificationHubOptions.cs, puis ajoutez l’implémentation suivante.

using System.ComponentModel.DataAnnotations;

namespace PushDemoApi.Models
{
    public class NotificationHubOptions
    {
        [Required]
        public string Name { get; set; }

        [Required]
        public string ConnectionString { get; set; }
    }
}

Ajoutez un nouveau dossier au projet PushDemoApi appelé Services.

Ajoutez une interface vide au dossier Services appelé INotificationService.cs, puis ajoutez l’implémentation suivante.

using System.Threading;
using System.Threading.Tasks;
using PushDemoApi.Models;

namespace PushDemoApi.Services
{
    public interface INotificationService
    {
        Task<bool> CreateOrUpdateInstallationAsync(DeviceInstallation deviceInstallation, CancellationToken token);
        Task<bool> DeleteInstallationByIdAsync(string installationId, CancellationToken token);
        Task<bool> RequestNotificationAsync(NotificationRequest notificationRequest, CancellationToken token);
    }
}

Ajoutez une classe vide au dossier Services appelé NotificationHubsService.cs, puis ajoutez le code suivant pour implémenter l’interface INotificationService :

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Azure.NotificationHubs;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;
using PushDemoApi.Models;

namespace PushDemoApi.Services
{
    public class NotificationHubService : INotificationService
    {
        readonly NotificationHubClient _hub;
        readonly Dictionary<string, NotificationPlatform> _installationPlatform;
        readonly ILogger<NotificationHubService> _logger;

        public NotificationHubService(IOptions<NotificationHubOptions> options, ILogger<NotificationHubService> logger)
        {
            _logger = logger;
            _hub = NotificationHubClient.CreateClientFromConnectionString(
                options.Value.ConnectionString,
                options.Value.Name);

            _installationPlatform = new Dictionary<string, NotificationPlatform>
            {
                { nameof(NotificationPlatform.Apns).ToLower(), NotificationPlatform.Apns },
                { nameof(NotificationPlatform.Fcm).ToLower(), NotificationPlatform.Fcm }
            };
        }

        public async Task<bool> CreateOrUpdateInstallationAsync(DeviceInstallation deviceInstallation, CancellationToken token)
        {
            if (string.IsNullOrWhiteSpace(deviceInstallation?.InstallationId) ||
                string.IsNullOrWhiteSpace(deviceInstallation?.Platform) ||
                string.IsNullOrWhiteSpace(deviceInstallation?.PushChannel))
                return false;

            var installation = new Installation()
            {
                InstallationId = deviceInstallation.InstallationId,
                PushChannel = deviceInstallation.PushChannel,
                Tags = deviceInstallation.Tags
            };

            if (_installationPlatform.TryGetValue(deviceInstallation.Platform, out var platform))
                installation.Platform = platform;
            else
                return false;

            try
            {
                await _hub.CreateOrUpdateInstallationAsync(installation, token);
            }
            catch
            {
                return false;
            }

            return true;
        }

        public async Task<bool> DeleteInstallationByIdAsync(string installationId, CancellationToken token)
        {
            if (string.IsNullOrWhiteSpace(installationId))
                return false;

            try
            {
                await _hub.DeleteInstallationAsync(installationId, token);
            }
            catch
            {
                return false;
            }

            return true;
        }

        public async Task<bool> RequestNotificationAsync(NotificationRequest notificationRequest, CancellationToken token)
        {
            if ((notificationRequest.Silent &&
                string.IsNullOrWhiteSpace(notificationRequest?.Action)) ||
                (!notificationRequest.Silent &&
                (string.IsNullOrWhiteSpace(notificationRequest?.Text)) ||
                string.IsNullOrWhiteSpace(notificationRequest?.Action)))
                return false;

            var androidPushTemplate = notificationRequest.Silent ?
                PushTemplates.Silent.Android :
                PushTemplates.Generic.Android;

            var iOSPushTemplate = notificationRequest.Silent ?
                PushTemplates.Silent.iOS :
                PushTemplates.Generic.iOS;

            var androidPayload = PrepareNotificationPayload(
                androidPushTemplate,
                notificationRequest.Text,
                notificationRequest.Action);

            var iOSPayload = PrepareNotificationPayload(
                iOSPushTemplate,
                notificationRequest.Text,
                notificationRequest.Action);

            try
            {
                if (notificationRequest.Tags.Length == 0)
                {
                    // This will broadcast to all users registered in the notification hub
                    await SendPlatformNotificationsAsync(androidPayload, iOSPayload, token);
                }
                else if (notificationRequest.Tags.Length <= 20)
                {
                    await SendPlatformNotificationsAsync(androidPayload, iOSPayload, notificationRequest.Tags, token);
                }
                else
                {
                    var notificationTasks = notificationRequest.Tags
                        .Select((value, index) => (value, index))
                        .GroupBy(g => g.index / 20, i => i.value)
                        .Select(tags => SendPlatformNotificationsAsync(androidPayload, iOSPayload, tags, token));

                    await Task.WhenAll(notificationTasks);
                }

                return true;
            }
            catch (Exception e)
            {
                _logger.LogError(e, "Unexpected error sending notification");
                return false;
            }
        }

        string PrepareNotificationPayload(string template, string text, string action) => template
            .Replace("$(alertMessage)", text, StringComparison.InvariantCulture)
            .Replace("$(alertAction)", action, StringComparison.InvariantCulture);

        Task SendPlatformNotificationsAsync(string androidPayload, string iOSPayload, CancellationToken token)
        {
            var sendTasks = new Task[]
            {
                _hub.SendFcmNativeNotificationAsync(androidPayload, token),
                _hub.SendAppleNativeNotificationAsync(iOSPayload, token)
            };

            return Task.WhenAll(sendTasks);
        }

        Task SendPlatformNotificationsAsync(string androidPayload, string iOSPayload, IEnumerable<string> tags, CancellationToken token)
        {
            var sendTasks = new Task[]
            {
                _hub.SendFcmNativeNotificationAsync(androidPayload, tags, token),
                _hub.SendAppleNativeNotificationAsync(iOSPayload, tags, token)
            };

            return Task.WhenAll(sendTasks);
        }
    }
}

Notes

L’expression de balise fournie à SendTemplateNotificationAsync est limitée à 20 balises. Elle est limitée à 6 pour la plupart des opérateurs, mais l’expression contient uniquement des UO (||) dans ce cas. S’il y a plus de 20 balises dans la demande, elles doivent être divisées en plusieurs requêtes. Pour plus d’informations, consultez la documentation sur le routage et les expressions de balise.

Dans Startup.cs, mettez à jour la méthode ConfigureServices pour ajouter NotificationHubsService en tant qu’implémentation singleton d’INotificationService.


using PushDemoApi.Models;
using PushDemoApi.Services;

public void ConfigureServices(IServiceCollection services)
{
    ...

    services.AddSingleton<INotificationService, NotificationHubService>();

    services.AddOptions<NotificationHubOptions>()
        .Configure(Configuration.GetSection("NotificationHub").Bind)
        .ValidateDataAnnotations();
}

Créer l’API de notifications

Contrôle + Cliquez sur le dossier Contrôleurs , puis choisissez Nouveau fichier... dans le menu Ajouter .
Sélectionnez ASP.NET Core>Classe de contrôleur d’API Web, entrez NotificationsController comme Nom, puis cliquez sur Nouveau.

Notes

Si vous suivez Visual Studio 2019, choisissez le modèle Contrôleur d’API avec actions de lecture/écriture .

Ajoutez les espaces de noms suivants en haut du fichier.

using System.ComponentModel.DataAnnotations;
using System.Net;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Mvc;
using PushDemoApi.Models;
using PushDemoApi.Services;

Mettez à jour le contrôleur modèle afin qu’il dérive de ControllerBase et qu’il soit décoré avec l’attribut ApiController .
```
[ApiController]
[Route("api/[controller]")]
public class NotificationsController : ControllerBase
{
    // Templated methods here
}
```
Notes

La classe de base du contrôleur prend en charge les vues, mais ce n’est pas nécessaire dans ce cas et peut donc être utilisé à la place. Si vous suivez Visual Studio 2019, vous pouvez ignorer cette étape.
Si vous avez choisi d’effectuer la section Authentifier les clients à l’aide d’une clé API , vous devez également décorer notificationsController avec l’attribut Authorize .
```
[Authorize]
```

Mettez à jour le constructeur pour qu’il accepte le instance inscrit d’INotificationService en tant qu’argument et attribuez-le à un membre en lecture seule.

readonly INotificationService _notificationService;

public NotificationsController(INotificationService notificationService)
{
    _notificationService = notificationService;
}

Dans launchSettings.json (dans le dossier Propriétés ), remplacez le launchUrl par weatherforecastapi/notifications pour qu’il corresponde à l’URL spécifiée dans l’attribut RegistrationsControllerRoute .
Démarrez le débogage (Entrée decommande + ) pour vérifier que l’application fonctionne avec le nouveau NotificationsController et retourne un status non autorisé 401.

Notes

Visual Studio peut ne pas lancer automatiquement l’application dans le navigateur. Vous allez utiliser Postman pour tester l’API à partir de ce point.
Dans un nouvel onglet Postman , définissez la demande sur GET. Entrez l’adresse ci-dessous en remplaçant l’espace réservé <applicationUrl> par l’applicationUrl https trouvée dans Propriétés>launchSettings.json.
```
<applicationUrl>/api/notifications
```
Notes

ApplicationUrl doit être «https://localhost:5001 » pour le profil par défaut. Si vous utilisez IIS (par défaut dans Visual Studio 2019 sur Windows), vous devez utiliser l’applicationUrl spécifié dans l’élément iisSettings à la place. Vous recevrez une réponse 404 si l’adresse est incorrecte.
Si vous avez choisi d’effectuer la section Authentifier les clients à l’aide d’une clé API , veillez à configurer les en-têtes de requête pour inclure votre valeur apikey .

Clé Valeur

apikey <your_api_key>
Cliquez sur le bouton Envoyer .

Notes

Vous devez recevoir un status 200 OK avec du contenu JSON.

Si vous recevez un avertissement de vérification de certificat SSL , vous pouvez désactiver le paramètre Postman de vérification du certificat SSL de demande dans les paramètres.

Clé	Valeur
apikey	<your_api_key>

Remplacez les méthodes de classe modèle dans NotificationsController.cs par le code suivant.

[HttpPut]
[Route("installations")]
[ProducesResponseType((int)HttpStatusCode.OK)]
[ProducesResponseType((int)HttpStatusCode.BadRequest)]
[ProducesResponseType((int)HttpStatusCode.UnprocessableEntity)]
public async Task<IActionResult> UpdateInstallation(
    [Required]DeviceInstallation deviceInstallation)
{
    var success = await _notificationService
        .CreateOrUpdateInstallationAsync(deviceInstallation, HttpContext.RequestAborted);

    if (!success)
        return new UnprocessableEntityResult();

    return new OkResult();
}

[HttpDelete()]
[Route("installations/{installationId}")]
[ProducesResponseType((int)HttpStatusCode.OK)]
[ProducesResponseType((int)HttpStatusCode.BadRequest)]
[ProducesResponseType((int)HttpStatusCode.UnprocessableEntity)]
public async Task<ActionResult> DeleteInstallation(
    [Required][FromRoute]string installationId)
{
    var success = await _notificationService
        .DeleteInstallationByIdAsync(installationId, CancellationToken.None);

    if (!success)
        return new UnprocessableEntityResult();

    return new OkResult();
}

[HttpPost]
[Route("requests")]
[ProducesResponseType((int)HttpStatusCode.OK)]
[ProducesResponseType((int)HttpStatusCode.BadRequest)]
[ProducesResponseType((int)HttpStatusCode.UnprocessableEntity)]
public async Task<IActionResult> RequestPush(
    [Required]NotificationRequest notificationRequest)
{
    if ((notificationRequest.Silent &&
        string.IsNullOrWhiteSpace(notificationRequest?.Action)) ||
        (!notificationRequest.Silent &&
        string.IsNullOrWhiteSpace(notificationRequest?.Text)))
        return new BadRequestResult();

    var success = await _notificationService
        .RequestNotificationAsync(notificationRequest, HttpContext.RequestAborted);

    if (!success)
        return new UnprocessableEntityResult();

    return new OkResult();
}

Créer l’application API

Vous créez maintenant une application API dans Azure App Service pour héberger le service back-end.

Connectez-vous au portail Azure.
Cliquez sur Créer une ressource, recherchez et choisissez Application API, puis cliquez sur Créer.
Mettez à jour les champs suivants, puis cliquez sur Créer.

Nom de l’application :
Entrez un nom global unique pour l’application API

Abonnement:
Choisissez l’abonnement cible dans lequel vous avez créé le hub de notification.

Groupe de ressources :
Choisissez le groupe de ressources dans lequel vous avez créé le hub de notification.

App Service plan/emplacement :
Créer un plan App Service

Notes

Passez de l’option par défaut à un plan qui inclut la prise en charge SSL . Sinon, vous devez prendre les mesures appropriées lors de l’utilisation de l’application mobile pour empêcher le blocage des requêtes http .

Application Insights :
Conservez l’option suggérée (une nouvelle ressource sera créée à l’aide de ce nom) ou choisissez une ressource existante.
Une fois l’application API approvisionnée, accédez à cette ressource.
Notez la propriété URL dans le résumé Essentials en haut de la vue d’ensemble. Cette URL est votre point de terminaison principal qui sera utilisé plus loin dans ce tutoriel.

Notes

L’URL utilise le nom de l’application API que vous avez spécifié précédemment, au format https://<app_name>.azurewebsites.net.
Sélectionnez Configuration dans la liste (sous Paramètres).
Pour chacun des paramètres ci-dessous, cliquez sur Nouveau paramètre d’application pour entrer le Nom et une Valeur, puis cliquez sur OK.

Nom Valeur

Authentication:ApiKey <api_key_value>

NotificationHub:Name <hub_name_value>

NotificationHub:ConnectionString <hub_connection_string_value>

Notes

Il s’agit des mêmes paramètres que vous avez définis précédemment dans les paramètres utilisateur. Vous devriez pouvoir les copier. Le paramètre Authentication :ApiKey est requis uniquement si vous avez choisi d’effectuer la section Authentifier les clients à l’aide d’une clé API . Pour les scénarios de production, vous pouvez examiner des options telles qu’Azure KeyVault. Ceux-ci ont été ajoutés en tant que paramètres d’application par souci de simplicité dans ce cas.
Une fois que tous les paramètres d’application ont été ajoutés, cliquez sur Enregistrer, puis sur Continuer.

Nom	Valeur
`Authentication:ApiKey`	<api_key_value>
`NotificationHub:Name`	<hub_name_value>
`NotificationHub:ConnectionString`	<hub_connection_string_value>

Publier le service back-end

Ensuite, vous déployez l’application sur l’application API pour la rendre accessible à partir de tous les appareils.

Notes

Les étapes suivantes sont spécifiques à Visual Studio pour Mac. Si vous suivez avec Visual Studio 2019 sur Windows, le flux de publication sera différent. Consultez Publier sur Azure App Service sur Windows.

Si vous ne l’avez pas déjà fait, modifiez votre configuration de Debug à Release .
Contrôle + Cliquez sur le projet PushDemoApi , puis choisissez Publier sur Azure... dans le menu Publier .
Suivez le flux d’authentification si vous y êtes invité. Utilisez le compte que vous avez utilisé dans la section créer l’application API précédente.
Sélectionnez l’application API Azure App Service que vous avez créée précédemment dans la liste comme cible de publication, puis cliquez sur Publier.

Une fois l’Assistant terminé, il publie l’application sur Azure, puis ouvre l’application. Notez l’URL si vous ne l’avez pas déjà fait. Cette URL est votre point de terminaison principal qui est utilisé plus loin dans ce tutoriel.

Validation de l’API publiée

Dans Postman , ouvrez un nouvel onglet, définissez la requête sur PUT et entrez l’adresse ci-dessous. Remplacez l’espace réservé par l’adresse de base que vous avez notée dans la section précédente publier le service back-end .
```
https://<app_name>.azurewebsites.net/api/notifications/installations
```
Notes

L’adresse de base doit être au format https://<app_name>.azurewebsites.net/
Si vous avez choisi de terminer la section Authentifier les clients à l’aide d’une clé API , veillez à configurer les en-têtes de requête pour inclure votre valeur apikey .

Clé Valeur

apikey <your_api_key>
Choisissez l’option brutepour corps, choisissez JSON dans la liste des options de format, puis incluez du contenu JSON d’espace réservé :
```
{}
```
Cliquez sur Envoyer.

Notes

Vous devez recevoir un status UnprocessableEntity 422 du service.
Effectuez à nouveau les étapes 1 à 4, mais cette fois en spécifiant le point de terminaison des demandes pour valider, vous recevez une réponse 400 demande incorrecte .
```
https://<app_name>.azurewebsites.net/api/notifications/requests
```

Clé	Valeur
apikey	<your_api_key>

Notes

Il n’est pas encore possible de tester l’API à l’aide de données de requête valides, car cela nécessite des informations spécifiques à la plateforme de l’application mobile cliente.

Créer une application Xamarin.Forms multiplateforme

Dans cette section, vous allez créer une application mobile Xamarin.Forms implémentant des notifications Push de manière multiplateforme.

Il vous permet de vous inscrire et de vous désinscrire à partir d’un hub de notification via le service back-end que vous avez créé.

Une alerte s’affiche lorsqu’une action est spécifiée et que l’application se trouve au premier plan. Sinon, les notifications s’affichent dans le centre de notifications.

Notes

Vous effectuez généralement les actions d’inscription (et de désinscription) pendant le point approprié du cycle de vie de l’application (ou dans le cadre de votre expérience de première exécution peut-être) sans entrées d’inscription/désinscription explicites de l’utilisateur. Toutefois, cet exemple nécessite une entrée explicite de l’utilisateur pour permettre à cette fonctionnalité d’être explorée et testée plus facilement.

Créer la solution Xamarin.Forms

Dans Visual Studio, créez une solution Xamarin.Forms en utilisant l’application Forms vide comme modèle et en entrant PushDemo comme nom du projet.

Notes

Dans la boîte de dialogue Configurer votre application formulaires vide , vérifiez que l’identificateur d’organisation correspond à la valeur que vous avez utilisée précédemment et que les cibles Android et iOS sont cochées.
Contrôle + Cliquez sur la solution PushDemo , puis choisissez Mettre à jour les packages NuGet.
Contrôle + Cliquez sur la solution PushDemo , puis choisissez Gérer les packages NuGet...
Recherchez Newtonsoft.Json et vérifiez qu’il est coché.
Cliquez sur Ajouter des packages, puis sur Accepter lorsque vous êtes invité à accepter les termes du contrat de licence.
Générez et exécutez l’application sur chaque plateforme cible (Entrée decommande + ) pour tester les exécutions de l’application avec modèle sur vos appareils.

Implémenter les composants multiplateformes

Contrôle + Cliquez sur le projet PushDemo , choisissez Nouveau dossier dans le menu Ajouter , puis cliquez sur Ajouter à l’aide de modèles comme nom du dossier.
Contrôle + Cliquez sur le dossier Models , puis choisissez Nouveau fichier... dans le menu Ajouter .

Sélectionnez Classe vide générale>, entrez DeviceInstallation.cs, puis ajoutez l’implémentation suivante.

using System.Collections.Generic;
using Newtonsoft.Json;

namespace PushDemo.Models
{
    public class DeviceInstallation
    {
        [JsonProperty("installationId")]
        public string InstallationId { get; set; }

        [JsonProperty("platform")]
        public string Platform { get; set; }

        [JsonProperty("pushChannel")]
        public string PushChannel { get; set; }

        [JsonProperty("tags")]
        public List<string> Tags { get; set; } = new List<string>();
    }
}

Ajoutez une énumération vide au dossier Models appelée PushDemoAction.cs avec l’implémentation suivante.

namespace PushDemo.Models
{
    public enum PushDemoAction
    {
        ActionA,
        ActionB
    }
}

Ajoutez un nouveau dossier au projet PushDemo appelé Services , puis ajoutez une classe vide à ce dossier appelé ServiceContainer.cs avec l’implémentation suivante.

using System;
using System.Collections.Generic;

namespace PushDemo.Services
{
   public static class ServiceContainer
   {
       static readonly Dictionary<Type, Lazy<object>> services
           = new Dictionary<Type, Lazy<object>>();

       public static void Register<T>(Func<T> function)
           => services[typeof(T)] = new Lazy<object>(() => function());

       public static T Resolve<T>()
           => (T)Resolve(typeof(T));

       public static object Resolve(Type type)
       {
           {
               if (services.TryGetValue(type, out var service))
                   return service.Value;

               throw new KeyNotFoundException($"Service not found for type '{type}'");
           }
       }
   }
}

Notes

Il s’agit d’une version supprimée de la classe ServiceContainer du référentiel XamCAT . Il sera utilisé comme conteneur IoC (Inversion of Control) léger.

Ajoutez une interface vide au dossier Services appelée IDeviceInstallationService.cs, puis ajoutez le code suivant.
```
using PushDemo.Models;

namespace PushDemo.Services
{
    public interface IDeviceInstallationService
    {
        string Token { get; set; }
        bool NotificationsSupported { get; }
        string GetDeviceId();
        DeviceInstallation GetDeviceInstallation(params string[] tags);
    }
}
```
Notes

Cette interface sera implémentée et démarrée par chaque cible ultérieurement pour fournir les fonctionnalités spécifiques à la plateforme et les informations DeviceInstallation requises par le service back-end.

Ajoutez une autre interface vide au dossier Services appelée INotificationRegistrationService.cs, puis ajoutez le code suivant.

using System.Threading.Tasks;

namespace PushDemo.Services
{
    public interface INotificationRegistrationService
    {
        Task DeregisterDeviceAsync();
        Task RegisterDeviceAsync(params string[] tags);
        Task RefreshRegistrationAsync();
    }
}

Notes

Cette opération gère l’interaction entre le client et le service principal.

Ajoutez une autre interface vide au dossier Services appelée INotificationActionService.cs, puis ajoutez le code suivant.
```
namespace PushDemo.Services
{
    public interface INotificationActionService
    {
        void TriggerAction(string action);
    }
}
```
Notes

Il s’agit d’un mécanisme simple permettant de centraliser la gestion des actions de notification.
Ajoutez une interface vide au dossier Services appelée IPushDemoNotificationActionService.cs qui dérive de INotificationActionService, avec l’implémentation suivante.
```
using System;
using PushDemo.Models;

namespace PushDemo.Services
{
    public interface IPushDemoNotificationActionService : INotificationActionService
    {
        event EventHandler<PushDemoAction> ActionTriggered;
    }
}
```
Notes

Ce type est spécifique à l’application PushDemo et utilise l’énumération PushDemoAction pour identifier l’action déclenchée de manière fortement typée.

Ajoutez une classe vide au dossier Services appelée NotificationRegistrationService.cs implémentant INotificationRegistrationService avec le code suivant.

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
using PushDemo.Models;
using Xamarin.Essentials;

namespace PushDemo.Services
{
    public class NotificationRegistrationService : INotificationRegistrationService
    {
        const string RequestUrl = "api/notifications/installations";
        const string CachedDeviceTokenKey = "cached_device_token";
        const string CachedTagsKey = "cached_tags";

        string _baseApiUrl;
        HttpClient _client;
        IDeviceInstallationService _deviceInstallationService;

        public NotificationRegistrationService(string baseApiUri, string apiKey)
        {
            _client = new HttpClient();
            _client.DefaultRequestHeaders.Add("Accept", "application/json");
            _client.DefaultRequestHeaders.Add("apikey", apiKey);

            _baseApiUrl = baseApiUri;
        }

        IDeviceInstallationService DeviceInstallationService
            => _deviceInstallationService ??
                (_deviceInstallationService = ServiceContainer.Resolve<IDeviceInstallationService>());

        public async Task DeregisterDeviceAsync()
        {
            var cachedToken = await SecureStorage.GetAsync(CachedDeviceTokenKey)
                .ConfigureAwait(false);

            if (cachedToken == null)
                return;

            var deviceId = DeviceInstallationService?.GetDeviceId();

            if (string.IsNullOrWhiteSpace(deviceId))
                throw new Exception("Unable to resolve an ID for the device.");

            await SendAsync(HttpMethod.Delete, $"{RequestUrl}/{deviceId}")
                .ConfigureAwait(false);

            SecureStorage.Remove(CachedDeviceTokenKey);
            SecureStorage.Remove(CachedTagsKey);
        }

        public async Task RegisterDeviceAsync(params string[] tags)
        {
            var deviceInstallation = DeviceInstallationService?.GetDeviceInstallation(tags);

            await SendAsync<DeviceInstallation>(HttpMethod.Put, RequestUrl, deviceInstallation)
                .ConfigureAwait(false);

            await SecureStorage.SetAsync(CachedDeviceTokenKey, deviceInstallation.PushChannel)
                .ConfigureAwait(false);

            await SecureStorage.SetAsync(CachedTagsKey, JsonConvert.SerializeObject(tags));
        }

        public async Task RefreshRegistrationAsync()
        {
            var cachedToken = await SecureStorage.GetAsync(CachedDeviceTokenKey)
                .ConfigureAwait(false);

            var serializedTags = await SecureStorage.GetAsync(CachedTagsKey)
                .ConfigureAwait(false);

            if (string.IsNullOrWhiteSpace(cachedToken) ||
                string.IsNullOrWhiteSpace(serializedTags) ||
                string.IsNullOrWhiteSpace(DeviceInstallationService.Token) ||
                cachedToken == DeviceInstallationService.Token)
                return;

            var tags = JsonConvert.DeserializeObject<string[]>(serializedTags);

            await RegisterDeviceAsync(tags);
        }

        async Task SendAsync<T>(HttpMethod requestType, string requestUri, T obj)
        {
            string serializedContent = null;

            await Task.Run(() => serializedContent = JsonConvert.SerializeObject(obj))
                .ConfigureAwait(false);

            await SendAsync(requestType, requestUri, serializedContent);
        }

        async Task SendAsync(
            HttpMethod requestType,
            string requestUri,
            string jsonRequest = null)
        {
            var request = new HttpRequestMessage(requestType, new Uri($"{_baseApiUrl}{requestUri}"));

            if (jsonRequest != null)
                request.Content = new StringContent(jsonRequest, Encoding.UTF8, "application/json");

            var response = await _client.SendAsync(request).ConfigureAwait(false);

            response.EnsureSuccessStatusCode();
        }
    }
}

Notes

L’argument apiKey n’est requis que si vous avez choisi de terminer la section Authentifier les clients à l’aide d’une clé API .

Ajoutez une classe vide au dossier Services appelée PushDemoNotificationActionService.cs implémentant IPushDemoNotificationActionService avec le code suivant.

using System;
using System.Collections.Generic;
using System.Linq;
using PushDemo.Models;

namespace PushDemo.Services
{
    public class PushDemoNotificationActionService : IPushDemoNotificationActionService
    {
        readonly Dictionary<string, PushDemoAction> _actionMappings = new Dictionary<string, PushDemoAction>
        {
            { "action_a", PushDemoAction.ActionA },
            { "action_b", PushDemoAction.ActionB }
        };

        public event EventHandler<PushDemoAction> ActionTriggered = delegate { };

        public void TriggerAction(string action)
        {
            if (!_actionMappings.TryGetValue(action, out var pushDemoAction))
                return;

            List<Exception> exceptions = new List<Exception>();

            foreach (var handler in ActionTriggered?.GetInvocationList())
            {
                try
                {
                    handler.DynamicInvoke(this, pushDemoAction);
                }
                catch (Exception ex)
                {
                    exceptions.Add(ex);
                }
            }

            if (exceptions.Any())
                throw new AggregateException(exceptions);
        }
    }
}

Ajoutez une classe vide au projet PushDemo appelée Config.cs avec l’implémentation suivante.
```
namespace PushDemo
{
    public static partial class Config
    {
        public static string ApiKey = "API_KEY";
        public static string BackendServiceEndpoint = "BACKEND_SERVICE_ENDPOINT";
    }
}
```
Notes

Il s’agit d’un moyen simple d’empêcher les secrets du contrôle de code source. Vous pouvez remplacer ces valeurs dans le cadre d’une build automatisée ou les remplacer à l’aide d’une classe partielle locale. Vous le ferez à l’étape suivante.

Le champ ApiKey n’est requis que si vous avez choisi d’effectuer la section Authentifier les clients à l’aide d’une clé API .
Ajoutez une autre classe vide au projet PushDemo cette fois appelée Config.local_secrets.cs avec l’implémentation suivante.
```
namespace PushDemo
{
    public static partial class Config
    {
        static Config()
        {
            ApiKey = "<your_api_key>";
            BackendServiceEndpoint = "<your_api_app_url>";
        }
    }
}
```
Notes

Remplacez les valeurs d’espace réservé par les vôtres. Vous devez avoir pris note de ceux-ci lorsque vous avez créé le service back-end. L’URL de l’application API doit être https://<api_app_name>.azurewebsites.net/. N’oubliez pas d’ajouter *.local_secrets.* à votre fichier gitignore pour éviter de valider ce fichier.

Le champ ApiKey n’est requis que si vous avez choisi d’effectuer la section Authentifier les clients à l’aide d’une clé API .

Ajoutez une classe vide au projet PushDemo appelée Bootstrap.cs avec l’implémentation suivante.

using System;
using PushDemo.Services;

namespace PushDemo
{
    public static class Bootstrap
    {
        public static void Begin(Func<IDeviceInstallationService> deviceInstallationService)
        {
            ServiceContainer.Register(deviceInstallationService);

            ServiceContainer.Register<IPushDemoNotificationActionService>(()
                => new PushDemoNotificationActionService());

            ServiceContainer.Register<INotificationRegistrationService>(()
                => new NotificationRegistrationService(
                    Config.BackendServiceEndpoint,
                    Config.ApiKey));
        }
    }
}

Notes

La méthode Begin est appelée par chaque plateforme lorsque l’application démarre en passant une implémentation spécifique à la plateforme d’IDeviceInstallationService.

L’argument du constructeur apiKey NotificationRegistrationService n’est requis que si vous avez choisi de terminer la section Authentifier les clients à l’aide d’une clé API.

Implémenter l’interface utilisateur multiplateforme

Dans le projet PushDemo , ouvrez MainPage.xaml et remplacez le contrôle StackLayout par ce qui suit.

<StackLayout VerticalOptions="EndAndExpand"  
             HorizontalOptions="FillAndExpand"
             Padding="20,40">
    <Button x:Name="RegisterButton"
            Text="Register"
            Clicked="RegisterButtonClicked" />
    <Button x:Name="DeregisterButton"
            Text="Deregister"
            Clicked="DeregisterButtonClicked" />
</StackLayout>

Maintenant, dans MainPage.xaml.cs, ajoutez un champ de stockage en lecture seule pour stocker une référence à l’implémentation INotificationRegistrationService .
```
readonly INotificationRegistrationService _notificationRegistrationService;
```
Dans le constructeur MainPage , résolvez l’implémentation de INotificationRegistrationService à l’aide du ServiceContainer et affectez-la au champ de stockage notificationRegistrationService .
```
public MainPage()
{
    InitializeComponent();

    _notificationRegistrationService =
        ServiceContainer.Resolve<INotificationRegistrationService>();
}
```

Implémentez les gestionnaires d’événements pour les boutons RegisterButton et DeregisterButtonévénements Clicked appelant les méthodes Register/Deregister correspondantes.

void RegisterButtonClicked(object sender, EventArgs e)
    => _notificationRegistrationService.RegisterDeviceAsync().ContinueWith((task)
        => { ShowAlert(task.IsFaulted ?
                task.Exception.Message :
                $"Device registered"); });

void DeregisterButtonClicked(object sender, EventArgs e)
    => _notificationRegistrationService.DeregisterDeviceAsync().ContinueWith((task)
        => { ShowAlert(task.IsFaulted ?
                task.Exception.Message :
                $"Device deregistered"); });

void ShowAlert(string message)
    => MainThread.BeginInvokeOnMainThread(()
        => DisplayAlert("PushDemo", message, "OK").ContinueWith((task)
            => { if (task.IsFaulted) throw task.Exception; }));

Maintenant, dans App.xaml.cs, vérifiez que les espaces de noms suivants sont référencés.

using PushDemo.Models;
using PushDemo.Services;
using Xamarin.Essentials;
using Xamarin.Forms;

Implémentez le gestionnaire d’événements pour l’événement IPushDemoNotificationActionServiceActionTriggered .

void NotificationActionTriggered(object sender, PushDemoAction e)
    => ShowActionAlert(e);

void ShowActionAlert(PushDemoAction action)
    => MainThread.BeginInvokeOnMainThread(()
        => MainPage?.DisplayAlert("PushDemo", $"{action} action received", "OK")
            .ContinueWith((task) => { if (task.IsFaulted) throw task.Exception; }));

Dans le constructeur d’application , résolvez l’implémentation IPushNotificationActionService à l’aide de ServiceContainer et abonnez-vous à l’événement IPushDemoNotificationActionServiceActionTriggered .
```
public App()
{
    InitializeComponent();

    ServiceContainer.Resolve<IPushDemoNotificationActionService>()
        .ActionTriggered += NotificationActionTriggered;

    MainPage = new MainPage();
}
```
Notes

Il s’agit simplement de démontrer la réception et la propagation des actions de notification Push. En règle générale, ils sont gérés en mode silencieux, par exemple en accédant à une vue spécifique ou en actualisant certaines données, plutôt que d’afficher une alerte via la page racine, MainPage dans ce cas.

Configurer le projet Android natif pour les notifications Push

Valider le nom et les autorisations du package

Dans PushDemo.Android, ouvrez options de projet , puis Application Android dans la section Build .
Vérifiez que le nom du package correspond à la valeur que vous avez utilisée dans le projet PushDemo de la console Firebase. Le nom du package était au format com.<organization>.pushdemo.
Définissez la version minimale d’Android sur Android 8.0 (niveau API 26) et la version Android cible sur le dernier niveau d’API.

Notes

Seuls les appareils exécutant l’API de niveau 26 et supérieur sont pris en charge dans le cadre de ce didacticiel, mais vous pouvez l’étendre pour prendre en charge les appareils exécutant des versions antérieures.
Vérifiez que les autorisations INTERNET et READ_PHONE_STATE sont activées sous Autorisations requises.
Cliquez sur OK

Ajouter les packages Xamarin Google Play Services base et Xamarin.Firebase.Messaging

Dans PushDemo.Android, contrôle + Cliquez sur le dossier Packages , puis choisissez Gérer les packages NuGet....
Recherchez Xamarin.GooglePlayServices.Base (et non Basement) et vérifiez qu’il est vérifié.
Recherchez Xamarin.Firebase.Messaging et vérifiez qu’il est vérifié.
Cliquez sur Ajouter des packages, puis cliquez sur Accepter lorsque vous êtes invité à accepter les termes du contrat de licence.

Ajouter le fichier JSON des services Google

Contrôle + Cliquez sur le PushDemo.Android projet, puis choisissez Fichier existant... dans le menu Ajouter .
Choisissez le fichier google-services.json que vous avez téléchargé précédemment lorsque vous configurez le projet PushDemo dans la console Firebase , puis cliquez sur Ouvrir.
Lorsque vous y êtes invité, choisissez De copier le fichier dans le répertoire.
Contrôle + Cliquez sur le fichier google-services.json dans le PushDemo.Android projet, puis vérifiez que GoogleServicesJson est défini comme action de génération.

Gérer les notifications Push pour Android

Contrôle + Cliquez sur le PushDemo.Android projet, choisissez Nouveau dossier dans le menu Ajouter , puis cliquez sur Ajouter à l’aide des services comme nom du dossier.
Contrôle + Cliquez sur le dossier Services , puis choisissez Nouveau fichier... dans le menu Ajouter .

Sélectionnez Classe vide générale>, entrez DeviceInstallationService.cs pour le nom, puis cliquez sur Nouveau en ajoutant l’implémentation suivante.

using System;
using Android.App;
using Android.Gms.Common;
using PushDemo.Models;
using PushDemo.Services;
using static Android.Provider.Settings;

namespace PushDemo.Droid.Services
{
    public class DeviceInstallationService : IDeviceInstallationService
    {
        public string Token { get; set; }

        public bool NotificationsSupported
            => GoogleApiAvailability.Instance
                .IsGooglePlayServicesAvailable(Application.Context) == ConnectionResult.Success;

        public string GetDeviceId()
            => Secure.GetString(Application.Context.ContentResolver, Secure.AndroidId);

        public DeviceInstallation GetDeviceInstallation(params string[] tags)
        {
            if (!NotificationsSupported)
                throw new Exception(GetPlayServicesError());

            if (string.IsNullOrWhiteSpace(Token))
                throw new Exception("Unable to resolve token for FCM");

            var installation = new DeviceInstallation
            {
                InstallationId = GetDeviceId(),
                Platform = "fcm",
                PushChannel = Token
            };

            installation.Tags.AddRange(tags);

            return installation;
        }

        string GetPlayServicesError()
        {
            int resultCode = GoogleApiAvailability.Instance.IsGooglePlayServicesAvailable(Application.Context);

            if (resultCode != ConnectionResult.Success)
                return GoogleApiAvailability.Instance.IsUserResolvableError(resultCode) ?
                           GoogleApiAvailability.Instance.GetErrorString(resultCode) :
                           "This device is not supported";

            return "An error occurred preventing the use of push notifications";
        }
    }
}

Notes

Cette classe fournit un ID unique (à l’aide de Secure.AndroidId) dans le cadre de la charge utile d’inscription du hub de notification.

Ajoutez une autre classe vide au dossier Services appelé PushNotificationFirebaseMessagingService.cs, puis ajoutez l’implémentation suivante.

using Android.App;
using Android.Content;
using Firebase.Messaging;
using PushDemo.Services;

namespace PushDemo.Droid.Services
{
    [Service]
    [IntentFilter(new[] { "com.google.firebase.MESSAGING_EVENT" })]
    public class PushNotificationFirebaseMessagingService : FirebaseMessagingService
    {
        IPushDemoNotificationActionService _notificationActionService;
        INotificationRegistrationService _notificationRegistrationService;
        IDeviceInstallationService _deviceInstallationService;

        IPushDemoNotificationActionService NotificationActionService
            => _notificationActionService ??
                (_notificationActionService =
                ServiceContainer.Resolve<IPushDemoNotificationActionService>());

        INotificationRegistrationService NotificationRegistrationService
            => _notificationRegistrationService ??
                (_notificationRegistrationService =
                ServiceContainer.Resolve<INotificationRegistrationService>());

        IDeviceInstallationService DeviceInstallationService
            => _deviceInstallationService ??
                (_deviceInstallationService =
                ServiceContainer.Resolve<IDeviceInstallationService>());

        public override void OnNewToken(string token)
        {
            DeviceInstallationService.Token = token;

            NotificationRegistrationService.RefreshRegistrationAsync()
                .ContinueWith((task) => { if (task.IsFaulted) throw task.Exception; });
        }

        public override void OnMessageReceived(RemoteMessage message)
        {
            if(message.Data.TryGetValue("action", out var messageAction))
                NotificationActionService.TriggerAction(messageAction);
        }
    }
}

Dans MainActivity.cs, vérifiez que les espaces de noms suivants ont été ajoutés en haut du fichier.

using System;
using Android.App;
using Android.Content;
using Android.Content.PM;
using Android.OS;
using Android.Runtime;
using Firebase.Iid;
using PushDemo.Droid.Services;
using PushDemo.Services;

Dans MainActivity.cs, définissez LaunchMode sur SingleTop afin que MainActivity ne soit pas créé à nouveau lors de l’ouverture.

[Activity(
    Label = "PushDemo",
    LaunchMode = LaunchMode.SingleTop,
    Icon = "@mipmap/icon",
    Theme = "@style/MainTheme",
    MainLauncher = true,
    ConfigurationChanges = ConfigChanges.ScreenSize | ConfigChanges.Orientation)]

Ajoutez des propriétés privées et des champs de stockage correspondants pour stocker une référence aux implémentations IPushNotificationActionService et IDeviceInstallationService .

IPushDemoNotificationActionService _notificationActionService;
IDeviceInstallationService _deviceInstallationService;

IPushDemoNotificationActionService NotificationActionService
    => _notificationActionService ??
        (_notificationActionService =
        ServiceContainer.Resolve<IPushDemoNotificationActionService>());

IDeviceInstallationService DeviceInstallationService
    => _deviceInstallationService ??
        (_deviceInstallationService =
        ServiceContainer.Resolve<IDeviceInstallationService>());

Implémentez l’interface IOnSuccessListener pour récupérer et stocker le jeton Firebase .

public class MainActivity : global::Xamarin.Forms.Platform.Android.FormsAppCompatActivity, Android.Gms.Tasks.IOnSuccessListener
{
    ...

    public void OnSuccess(Java.Lang.Object result)
        => DeviceInstallationService.Token =
            result.Class.GetMethod("getToken").Invoke(result).ToString();
}

Ajoutez une nouvelle méthode appelée ProcessNotificationActions qui case activée si une intention donnée a une valeur supplémentaire nommée action. Déclenchez cette action de manière conditionnelle à l’aide de l’implémentation IPushDemoNotificationActionService .

void ProcessNotificationActions(Intent intent)
{
    try
    {
        if (intent?.HasExtra("action") == true)
        {
            var action = intent.GetStringExtra("action");

            if (!string.IsNullOrEmpty(action))
                NotificationActionService.TriggerAction(action);
        }
    }
    catch (Exception ex)
    {
        System.Diagnostics.Debug.WriteLine(ex.Message);
    }
}

Remplacez la méthode OnNewIntent pour appeler la méthode ProcessNotificationActions .
```
protected override void OnNewIntent(Intent intent)
{
    base.OnNewIntent(intent);
    ProcessNotificationActions(intent);
}
```
Notes

Étant donné que LaunchMode pour l’activité est défini sur SingleTop, une intention est envoyée à l’instance d’activité existante via la méthode OnNewIntent plutôt que la méthode OnCreate. Vous devez donc gérer une intention entrante dans les méthodes OnCreate et OnNewIntent.
Mettez à jour la méthode OnCreate pour appeler Bootstrap.Begin juste après l’appel à passer l’implémentation spécifique à base.OnCreate la plateforme de IDeviceInstallationService.
```
Bootstrap.Begin(() => new DeviceInstallationService());
```
Dans la même méthode, appelez de manière conditionnelle GetInstanceId sur le instance FirebaseApp, juste après l’appel à Bootstrap.Begin, en ajoutant MainActivity comme IOnSuccessListener.
```
if (DeviceInstallationService.NotificationsSupported)
{
    FirebaseInstanceId.GetInstance(Firebase.FirebaseApp.Instance)
        .GetInstanceId()
        .AddOnSuccessListener(this);
}
```
Toujours dans OnCreate, appelez ProcessNotificationActions immédiatement après l’appel à LoadApplication en passant l’intention actuelle.
```
...

LoadApplication(new App());

ProcessNotificationActions(Intent);
```

Notes

Vous devez réinscrire l’application chaque fois que vous l’exécutez et l’arrêter à partir d’une session de débogage pour continuer à recevoir des notifications Push.

Configurer le projet iOS natif pour les notifications Push

Configurer Info.plist et Entitlements.plist

Assurez-vous que vous êtes connecté à votre compte de développeur Apple dansles préférencesde Visual Studio>...>Édition>Les comptes de développeur Apple et le certificat et le profil d’approvisionnement appropriés ont été téléchargés. Vous devez avoir créé ces ressources dans le cadre des étapes précédentes.
Dans PushDemo.iOS, ouvrez Info.plist et vérifiez que bundleIdentifier correspond à la valeur utilisée pour le profil d’approvisionnement respectif dans le portail des développeurs Apple. BundleIdentifier était au format com.<organization>.PushDemo.
Dans le même fichier, définissez Version système minimale sur 13.0.

Notes

Seuls les appareils exécutant iOS 13.0 et versions ultérieures sont pris en charge dans le cadre de ce didacticiel, mais vous pouvez l’étendre pour prendre en charge les appareils exécutant des versions antérieures.
Ouvrez les options du projet pour PushDemo.iOS (double-cliquez sur le projet).
Dans Options du projet, sous Créer la > signature de bundle iOS, vérifiez que votre compte de développeur est sélectionné sous Équipe. Ensuite, vérifiez que « Gérer automatiquement la signature » est sélectionné et que votre certificat de signature et votre profil d’approvisionnement sont automatiquement sélectionnés.

Notes

Si votre certificat de signature et votre profil d’approvisionnement n’ont pas été automatiquement sélectionnés, choisissez Approvisionnement manuel, puis cliquez sur Options de signature groupée. Vérifiez que votre équipe est sélectionnée pour l’identité de signature et que votre profil d’approvisionnement spécifique à PushDemo est sélectionné pour le profil d’approvisionnement pour les configurations Debug et Release , ce qui garantit que l’iPhone est sélectionné pour la plateforme dans les deux cas.
Dans PushDemo.iOS, ouvrez Entitlements.plist et vérifiez que l’option Activer les notifications Push est cochée dans l’onglet Droits . Vérifiez ensuite que le paramètre Environnement APS est défini sur le développement lorsqu’il est affiché sous l’onglet Source .

Gérer les notifications Push pour iOS

Contrôle + Cliquez sur le projet PushDemo.iOS , choisissez Nouveau dossier dans le menu Ajouter , puis cliquez sur Ajouter à l’aide des services comme nom du dossier.
Contrôle + Cliquez sur le dossier Services , puis choisissez Nouveau fichier... dans le menu Ajouter .

Sélectionnez Classe vide générale>, entrez DeviceInstallationService.cs pour le nom, puis cliquez sur Nouveau en ajoutant l’implémentation suivante.

using System;
using PushDemo.Models;
using PushDemo.Services;
using UIKit;

namespace PushDemo.iOS.Services
{
    public class DeviceInstallationService : IDeviceInstallationService
    {
        const int SupportedVersionMajor = 13;
        const int SupportedVersionMinor = 0;

        public string Token { get; set; }

        public bool NotificationsSupported
            => UIDevice.CurrentDevice.CheckSystemVersion(SupportedVersionMajor, SupportedVersionMinor);

        public string GetDeviceId()
            => UIDevice.CurrentDevice.IdentifierForVendor.ToString();

        public DeviceInstallation GetDeviceInstallation(params string[] tags)
        {
            if (!NotificationsSupported)
                throw new Exception(GetNotificationsSupportError());

            if (string.IsNullOrWhiteSpace(Token))
                throw new Exception("Unable to resolve token for APNS");

            var installation = new DeviceInstallation
            {
                InstallationId = GetDeviceId(),
                Platform = "apns",
                PushChannel = Token
            };

            installation.Tags.AddRange(tags);

            return installation;
        }

        string GetNotificationsSupportError()
        {
            if (!NotificationsSupported)
                return $"This app only supports notifications on iOS {SupportedVersionMajor}.{SupportedVersionMinor} and above. You are running {UIDevice.CurrentDevice.SystemVersion}.";

            if (Token == null)
                return $"This app can support notifications but you must enable this in your settings.";


            return "An error occurred preventing the use of push notifications";
        }
    }
}

Notes

Cette classe fournit un ID unique (à l’aide de la valeur UIDevice.IdentifierForVendor ) et la charge utile d’inscription du hub de notification.

Ajoutez un nouveau dossier au projet PushDemo.iOS appelé Extensions , puis ajoutez une classe vide à ce dossier appelé NSDataExtensions.cs avec l’implémentation suivante.

using System.Text;
using Foundation;

namespace PushDemo.iOS.Extensions
{
    internal static class NSDataExtensions
    {
        internal static string ToHexString(this NSData data)
        {
            var bytes = data.ToArray();

            if (bytes == null)
                return null;

            StringBuilder sb = new StringBuilder(bytes.Length * 2);

            foreach (byte b in bytes)
                sb.AppendFormat("{0:x2}", b);

            return sb.ToString().ToUpperInvariant();
        }
    }
}

Dans AppDelegate.cs, vérifiez que les espaces de noms suivants ont été ajoutés en haut du fichier.

using System;
using System.Diagnostics;
using System.Threading.Tasks;
using Foundation;
using PushDemo.iOS.Extensions;
using PushDemo.iOS.Services;
using PushDemo.Services;
using UIKit;
using UserNotifications;
using Xamarin.Essentials;

Ajoutez des propriétés privées et leurs champs de stockage respectifs pour stocker une référence aux implémentations IPushDemoNotificationActionService, INotificationRegistrationService et IDeviceInstallationService .

IPushDemoNotificationActionService _notificationActionService;
INotificationRegistrationService _notificationRegistrationService;
IDeviceInstallationService _deviceInstallationService;

IPushDemoNotificationActionService NotificationActionService
    => _notificationActionService ??
        (_notificationActionService =
        ServiceContainer.Resolve<IPushDemoNotificationActionService>());

INotificationRegistrationService NotificationRegistrationService
    => _notificationRegistrationService ??
        (_notificationRegistrationService =
        ServiceContainer.Resolve<INotificationRegistrationService>());

IDeviceInstallationService DeviceInstallationService
    => _deviceInstallationService ??
        (_deviceInstallationService =
        ServiceContainer.Resolve<IDeviceInstallationService>());

Ajoutez la méthode RegisterForRemoteNotifications pour inscrire les paramètres de notification utilisateur, puis pour les notifications à distance avec APNS.

void RegisterForRemoteNotifications()
{
    MainThread.BeginInvokeOnMainThread(() =>
    {
        var pushSettings = UIUserNotificationSettings.GetSettingsForTypes(
            UIUserNotificationType.Alert |
            UIUserNotificationType.Badge |
            UIUserNotificationType.Sound,
            new NSSet());

        UIApplication.SharedApplication.RegisterUserNotificationSettings(pushSettings);
        UIApplication.SharedApplication.RegisterForRemoteNotifications();
    });
}

Ajoutez la méthode CompleteRegistrationAsync pour définir la valeur de la IDeviceInstallationService.Token propriété. Actualisez l’inscription et mettez en cache le jeton d’appareil s’il a été mis à jour depuis son dernier stockage.
```
Task CompleteRegistrationAsync(NSData deviceToken)
{
    DeviceInstallationService.Token = deviceToken.ToHexString();
    return NotificationRegistrationService.RefreshRegistrationAsync();
}
```

Ajoutez la méthode ProcessNotificationActions pour traiter les données de notification NSDictionary et appeler de manière conditionnelle NotificationActionService.TriggerAction.

void ProcessNotificationActions(NSDictionary userInfo)
{
    if (userInfo == null)
        return;

    try
    {
        var actionValue = userInfo.ObjectForKey(new NSString("action")) as NSString;

        if (!string.IsNullOrWhiteSpace(actionValue?.Description))
            NotificationActionService.TriggerAction(actionValue.Description);
    }
    catch (Exception ex)
    {
        Debug.WriteLine(ex.Message);
    }
}

Remplacez la méthode RegisteredForRemoteNotifications en passant l’argument deviceToken à la méthode CompleteRegistrationAsync .

public override void RegisteredForRemoteNotifications(
    UIApplication application,
    NSData deviceToken)
    => CompleteRegistrationAsync(deviceToken).ContinueWith((task)
        => { if (task.IsFaulted) throw task.Exception; });

Remplacez la méthode ReceivedRemoteNotification en passant l’argument userInfo à la méthode ProcessNotificationActions .

public override void ReceivedRemoteNotification(
    UIApplication application,
    NSDictionary userInfo)
    => ProcessNotificationActions(userInfo);

Remplacez la méthode FailedToRegisterForRemoteNotifications pour consigner l’erreur.
```
public override void FailedToRegisterForRemoteNotifications(
    UIApplication application,
    NSError error)
    => Debug.WriteLine(error.Description);
```
Notes

Il s’agit d’un espace réservé. Vous souhaiterez implémenter une journalisation et une gestion des erreurs appropriées pour les scénarios de production.
Mettez à jour la méthode FinishedLaunching pour appeler Bootstrap.Begin juste après l’appel à passer l’implémentation spécifique à Forms.Init la plateforme de IDeviceInstallationService.
```
Bootstrap.Begin(() => new DeviceInstallationService());
```

Dans la même méthode, demandez une autorisation conditionnelle et inscrivez-vous aux notifications à distance immédiatement après Bootstrap.Begin.

if (DeviceInstallationService.NotificationsSupported)
{
    UNUserNotificationCenter.Current.RequestAuthorization(
            UNAuthorizationOptions.Alert |
            UNAuthorizationOptions.Badge |
            UNAuthorizationOptions.Sound,
            (approvalGranted, error) =>
            {
                if (approvalGranted && error == null)
                    RegisterForRemoteNotifications();
            });
}

Toujours dans FinishedLaunching, appelez ProcessNotificationActions immédiatement après l’appel à LoadApplication si l’argument options contient l’argument UIApplication.LaunchOptionsRemoteNotificationKey passant dans l’objet userInfo résultant.
```
using (var userInfo = options?.ObjectForKey(
    UIApplication.LaunchOptionsRemoteNotificationKey) as NSDictionary)
        ProcessNotificationActions(userInfo);
```

Tester la solution

Vous pouvez maintenant tester l’envoi de notifications via le service back-end.

Envoyer une notification de test

Ouvrez un nouvel onglet dans Postman.
Définissez la demande sur POST, puis entrez l’adresse suivante :
```
https://<app_name>.azurewebsites.net/api/notifications/requests
```
Si vous avez choisi d’effectuer la section Authentifier les clients à l’aide d’une clé API , veillez à configurer les en-têtes de requête pour inclure votre valeur apikey .

Clé Valeur

apikey <your_api_key>
Choisissez l’option brute du Corps, puis choisissez JSON dans la liste des options de format, puis incluez du contenu JSON d’espace réservé :
```
{
    "text": "Message from Postman!",
    "action": "action_a"
}
```
Sélectionnez le bouton Code , qui se trouve sous le bouton Enregistrer en haut à droite de la fenêtre. La demande doit ressembler à l’exemple suivant lorsqu’elle est affichée pour le code HTML (selon que vous avez inclus ou non un en-tête apikey ) :
```
POST /api/notifications/requests HTTP/1.1
Host: https://<app_name>.azurewebsites.net
apikey: <your_api_key>
Content-Type: application/json

{
    "text": "Message from backend service",
    "action": "action_a"
}
```
Exécutez l’application PushDemo sur l’une ou les deux plateformes cibles (Android et iOS).

Notes

Si vous testez sur Android , assurez-vous que vous n’exécutez pas dans Déboguer, ou si l’application a été déployée en exécutant l’application, forcez la fermeture de l’application et redémarrez-la à partir du lanceur.
Dans l’application PushDemo , appuyez sur le bouton Inscrire .
De retour dans Postman, fermez la fenêtre Générer des extraits de code (si vous ne l’avez pas déjà fait), puis cliquez sur le bouton Envoyer .
Vérifiez que vous obtenez une réponse 200 OK dans Postman et que l’alerte s’affiche dans l’application montrant l’action ActionA reçue.
Fermez l’application PushDemo , puis cliquez à nouveau sur le bouton Envoyer dans Postman.
Vérifiez que vous obtenez à nouveau une réponse 200 OK dans Postman . Vérifiez qu’une notification s’affiche dans la zone de notification de l’application PushDemo avec le message correct.
Appuyez sur la notification pour confirmer qu’elle ouvre l’application et affiche l’actionA alerte reçue .
De retour dans Postman, modifiez le corps de la requête précédente pour envoyer une notification silencieuse spécifiant action_b au lieu de action_a pour la valeur d’action .
```
{
    "action": "action_b",
    "silent": true
}
```
Avec l’application toujours ouverte, cliquez sur le bouton Envoyer dans Postman.
Vérifiez que vous obtenez une réponse 200 OK dans Postman et que l’alerte s’affiche dans l’application montrant l’action ActionB reçue au lieu de l’action ActionA reçue.
Fermez l’application PushDemo , puis cliquez à nouveau sur le bouton Envoyer dans Postman.
Vérifiez que vous obtenez une réponse 200 OK dans Postman et que la notification silencieuse n’apparaît pas dans la zone de notification.

Clé	Valeur
apikey	<your_api_key>

Dépannage

Aucune réponse du service back-end

Lors du test local, vérifiez que le service back-end est en cours d’exécution et utilise le port approprié.

Si vous effectuez un test sur l’application API Azure, case activée le service est en cours d’exécution et a été déployé et a démarré sans erreur.

Veillez à case activée vous avez correctement spécifié l’adresse de base dans Postman ou dans la configuration de l’application mobile lors du test via le client. L’adresse de base doit être https://<api_name>.azurewebsites.net/ ou https://localhost:5001/ lors d’un test local.

Ne pas recevoir de notifications sur Android après le démarrage ou l’arrêt d’une session de débogage

Veillez à vous réinscrire après le démarrage ou l’arrêt d’une session de débogage. Le débogueur entraîne la génération d’un nouveau jeton Firebase . L’installation du hub de notification doit également être mise à jour.

Réception d’un code de status 401 à partir du service back-end

Vérifiez que vous définissez l’en-tête de requête apikey et que cette valeur correspond à celle que vous avez configurée pour le service back-end.

Si vous recevez cette erreur lors d’un test local, vérifiez que la valeur de clé que vous avez définie dans la configuration du client correspond à la valeur de paramètre utilisateur Authentication :ApiKey utilisée par l’API.

Si vous effectuez des tests avec une application API, vérifiez que la valeur de clé dans le fichier de configuration du client correspond au paramètre d’application Authentication :ApiKey que vous utilisez dans l’application API.

Notes

Si vous avez créé ou modifié ce paramètre après avoir déployé le service principal, vous devez redémarrer le service pour qu’il prenne effet.

Si vous avez choisi de ne pas terminer la section Authentifier les clients à l’aide d’une clé API , vérifiez que vous n’avez pas appliqué l’attribut Authorize à la classe NotificationsController .

Réception d’un code status 404 à partir du service back-end

Vérifiez que le point de terminaison et la méthode de requête HTTP sont corrects. Par exemple, les points de terminaison doivent être :

[PUT]https://<api_name>.azurewebsites.net/api/notifications/installations
[DELETE]https://<api_name>.azurewebsites.net/api/notifications/installations/<installation_id>
[POST]https://<api_name>.azurewebsites.net/api/notifications/requests

Ou lors d’un test local :

[PUT]https://localhost:5001/api/notifications/installations
[DELETE]https://localhost:5001/api/notifications/installations/<installation_id>
[POST]https://localhost:5001/api/notifications/requests

Lorsque vous spécifiez l’adresse de base dans l’application cliente, vérifiez qu’elle se termine par un /. L’adresse de base doit être https://<api_name>.azurewebsites.net/ ou https://localhost:5001/ lors d’un test local.

Impossible de s’inscrire et un message d’erreur de hub de notification s’affiche

Vérifiez que l’appareil de test dispose d’une connectivité réseau. Ensuite, déterminez la réponse Http status code en définissant un point d’arrêt pour inspecter la valeur de la propriété StatusCode dans httpResponse.

Passez en revue les suggestions de résolution des problèmes précédentes, le cas échéant, en fonction du code status.

Définissez un point d’arrêt sur les lignes qui retournent ces codes status spécifiques pour l’API correspondante. Essayez ensuite d’appeler le service back-end lors du débogage local.

Vérifiez que le service back-end fonctionne comme prévu via Postman à l’aide de la charge utile appropriée. Utilisez la charge utile réelle créée par le code client pour la plateforme en question.

Passez en revue les sections de configuration spécifiques à la plateforme pour vous assurer qu’aucune étape n’a été manquée. Vérifiez que les valeurs appropriées sont résolues pour installation id les variables et token pour la plateforme appropriée.

Impossible de résoudre un ID pour le message d’erreur de l’appareil s’affiche

Passez en revue les sections de configuration spécifiques à la plateforme pour vous assurer qu’aucune étape n’a été manquée.

Étapes suivantes

Vous devez maintenant avoir une application Xamarin.Forms de base connectée à un hub de notification via un service back-end et pouvoir envoyer et recevoir des notifications.

Vous devrez probablement adapter l’exemple utilisé dans ce didacticiel pour l’adapter à votre propre scénario. L’implémentation d’une gestion des erreurs, d’une logique de nouvelle tentative et d’une journalisation plus robustes est également recommandée.

Visual Studio App Center peut être rapidement incorporé dans des applications mobiles fournissant des analyses et des diagnostics pour faciliter la résolution des problèmes.

Tutoriel : Envoyer des notifications Push aux applications Xamarin.Forms à l’aide d’Azure Notification Hubs via un service back-end

Prérequis

Configurer Push Notification Services et Azure Notification Hub

Créer un projet Firebase et activer Firebase Cloud Messaging pour Android

Inscrire votre application iOS pour les notifications Push

Création d’un certificat pour Notification Hubs

OPTION 1 : Création d’un certificat Push p12 qui peut être chargé directement sur Notification Hub

OPTION 2 : Création d’un certificat p8 qui peut être utilisé pour l’authentification basée sur les jetons

Créer un profil d’approvisionnement pour l’application

Créer un hub de notification

Configurer votre hub de notification avec les informations APNS

OPTION 1 : Utilisation d’un certificat push .p12

OPTION 2 : Utilisation de l’authentification basée sur les jetons

Configurer votre hub de notification avec des informations FCM

Créer une application principale d’API web ASP.NET Core

Créer un projet web

Authentifier les clients à l’aide d’une clé API (facultatif)

Ajouter des dépendances et configurer des services

Créer l’API de notifications

Créer l’application API

Publier le service back-end

Validation de l’API publiée

Créer une application Xamarin.Forms multiplateforme

Créer la solution Xamarin.Forms

Implémenter les composants multiplateformes

Implémenter l’interface utilisateur multiplateforme

Configurer le projet Android natif pour les notifications Push

Valider le nom et les autorisations du package

Ajouter les packages Xamarin Google Play Services base et Xamarin.Firebase.Messaging

Ajouter le fichier JSON des services Google

Gérer les notifications Push pour Android

Configurer le projet iOS natif pour les notifications Push

Configurer Info.plist et Entitlements.plist

Gérer les notifications Push pour iOS

Tester la solution

Envoyer une notification de test

Dépannage

Aucune réponse du service back-end

Ne pas recevoir de notifications sur Android après le démarrage ou l’arrêt d’une session de débogage

Réception d’un code de status 401 à partir du service back-end

Réception d’un code status 404 à partir du service back-end

Impossible de s’inscrire et un message d’erreur de hub de notification s’affiche

Impossible de résoudre un ID pour le message d’erreur de l’appareil s’affiche

Liens connexes

Étapes suivantes

Ressources supplémentaires