Premiers pas avec l'API Notifications

Dans cet atelier de programmation, vous allez utiliser les fonctionnalités de base de l'API Notifications pour:

  • Demander l'autorisation d'envoyer des notifications
  • Envoyer des notifications
  • Tester les options de notification

Navigateurs pris en charge

  • 20
  • 14
  • 22
  • 7

Source

Remixer l'application exemple et l'afficher dans un nouvel onglet

Les notifications sont automatiquement bloquées dans l'application Glitch intégrée. Vous ne pourrez donc pas prévisualiser l'application sur cette page. Voici comment procéder:

  1. Cliquez sur Remix to Edit (Remixer pour modifier) pour rendre le projet modifiable.
  2. Pour prévisualiser le site, appuyez sur Afficher l'application, puis sur Plein écran plein écran.

Le Glitch devrait s'ouvrir dans un nouvel onglet Chrome:

Capture d'écran montrant l'application en direct remixée dans un nouvel onglet

Tout au long de cet atelier de programmation, modifiez le code du Glitch intégré sur cette page. Actualisez le nouvel onglet de votre application en ligne pour voir les modifications.

Se familiariser avec l'application de démarrage et son code

Commencez par découvrir l'application en ligne dans le nouvel onglet Chrome:

  1. Appuyez sur Ctrl+Maj+J (ou Cmd+Option+J sur Mac) pour ouvrir les outils de développement. Cliquez sur l'onglet Console.

    Le message suivant doit s'afficher dans la console:

    Notification permission is default

    Si vous ne savez pas ce que cela signifie, ne vous inquiétez pas, tout sera bientôt dévoilé !

  2. Cliquez sur les boutons de l'application en direct: Demander l'autorisation d'envoyer des notifications et Envoyer une notification.

    La console affiche les messages "TODO" à partir de deux bouchons de fonction: requestPermission et sendNotification. Voici les fonctions que vous allez implémenter dans cet atelier de programmation.

Examinons maintenant le code de l'application exemple dans le Glitch intégré sur cette page. Ouvrez public/index.js et examinez certaines parties importantes du code existant:

  • La fonction showPermission utilise l'API Notifications pour obtenir l'état actuel des autorisations du site et le consigner dans la console:

    // Print current permission state to console;
// update onscreen message.
function showPermission() {
  let permission = Notification.permission;
  console.log('Notification permission is ' + permission);
  let p = document.getElementById('permission');
  p.textContent = 'Notification permission is ' + permission;
}

    Avant de demander une autorisation, son état est default. Avec l'état d'autorisation default, un site doit demander l'autorisation et obtenir l'autorisation avant de pouvoir envoyer des notifications.

  • La fonction requestPermission est un bouchon:

    // Use the Notification API to request permission to send notifications.
function requestPermission() {
  console.log('TODO: Implement requestPermission()');
}

    Vous implémenterez cette fonction à l'étape suivante.

  • La fonction sendNotification est un bouchon:

    // Use the Notification constructor to create and send a new Notification.
function sendNotification() {
  console.log('TODO: Implement sendNotification()');
}

    Vous implémenterez cette fonction après avoir implémenté requestPermission.

  • L'écouteur d'événements window.onload appelle la fonction showPermission lors du chargement de la page et affiche l'état actuel des autorisations dans la console et sur la page:

    window.onload = () => { showPermission(); };

Demander l'autorisation d'envoyer des notifications

Au cours de cette étape, vous allez ajouter une fonctionnalité permettant de demander à l'utilisateur l'autorisation d'envoyer des notifications.

La méthode Notification.requestPermission() permet d'afficher un pop-up qui demande à l'utilisateur d'autoriser ou de bloquer les notifications de votre site.

  1. Remplacez le bouchon de la fonction requestPermission dans le fichier public/index.js par le code suivant:

    // Use the Notification API to request permission to send notifications.
function requestPermission() {
  Notification.requestPermission()
    .then((permission) => {
      console.log('Promise resolved: ' + permission);
      showPermission();
    })
    .catch((error) => {
      console.log('Promise was rejected');
      console.log(error);
    });
}

  2. Actualisez l'onglet Chrome dans lequel vous consultez votre application en ligne.

  3. Dans l'interface de l'application en direct, cliquez sur Demander l'autorisation d'envoyer des notifications. Un pop-up s'affiche.

L'utilisateur peut envoyer l'une des trois réponses suivantes dans le pop-up d'autorisation.

Réponse de l'utilisateur État d'autorisation des notifications
L'utilisateur sélectionne Autoriser. granted
L'utilisateur sélectionne Bloquer. denied
L'utilisateur ferme la fenêtre pop-up sans effectuer de sélection default

Si l'utilisateur clique sur "Autoriser" :

  • La propriété Notification.permission est définie sur granted.

  • Le site pourra afficher des notifications.

  • Les appels suivants à Notification.requestPermission seront résolus en granted sans pop-up.

Si l'utilisateur clique sur "Bloquer" :

  • La propriété Notification.permission est définie sur denied.

  • Le site ne pourra pas afficher de notifications à l'attention de l'utilisateur.

  • Les appels suivants à Notification.requestPermission seront résolus en denied sans pop-up.

Si l'utilisateur masque le pop-up:

  • Notification.permission reste default.

  • Le site ne pourra pas afficher de notifications à l'attention de l'utilisateur.

  • Les appels suivants à Notification.requestPermission généreront davantage de fenêtres pop-up.

    Toutefois, si l'utilisateur continue de masquer les pop-ups, le navigateur risque de bloquer le site, en définissant Notification.permission sur denied. Ni les pop-ups de demande d'autorisation, ni les notifications ne peuvent alors s'afficher à l'utilisateur.

    Au moment de la rédaction de ce document, le comportement du navigateur en réponse aux fenêtres pop-up d'autorisation des notifications ignorées reste susceptible d'évoluer. La meilleure façon de gérer cela est de toujours demander l'autorisation de notification en réponse à une interaction lancée par l'utilisateur afin qu'il s'y attende et sache ce qui se passe.

Envoyer une notification

Au cours de cette étape, vous allez envoyer une notification à l'utilisateur.

Vous allez utiliser le constructeur Notification pour créer une notification et tenter de l'afficher. Si l'état d'autorisation est granted, votre notification s'affiche.

  1. Remplacez le bouchon de la fonction sendNotification dans le fichier index.js par le code suivant:

    // Use the Notification constructor to create and send a new Notification.
function sendNotification() {
  let title = 'Test';
  let options = {
    body: 'Test body',
    // Other options can go here
  };
  console.log('Creating new notification');
  let notification = new Notification(title, options);
}

    Le constructeur Notification utilise deux paramètres: title et options. options est un objet dont les propriétés représentent les données et paramètres visuels que vous pouvez inclure dans une notification. Pour en savoir plus, consultez la documentation du MNM sur les paramètres de notification.

  2. Actualisez l'onglet Chrome dans lequel vous consultez votre application en ligne, puis cliquez sur le bouton Send notification (Envoyer une notification). Une notification contenant le texte Test body devrait s'afficher.

Que se passe-t-il lorsque vous envoyez des notifications sans autorisation ?

Au cours de cette étape, vous allez ajouter quelques lignes de code qui vous permettront de voir ce qui se passe lorsque vous tentez d'afficher une notification sans l'autorisation de l'utilisateur.

  • Dans public/index.js, à la fin de la fonction sendNotification, définissez le gestionnaire d'événements onerror de la nouvelle notification:
// Use the Notification constructor to create and send a new Notification.
function sendNotification() {
  let title = 'Test';
  let options = {
    body: 'Test body',
    // Other options can go here
  };
  console.log('Creating new notification');
  let notification = new Notification(title, options);
  notification.onerror = (event) => {
    console.log('Could not send notification');
    console.log(event);
  };
}

Pour observer une erreur d'autorisation de notification:

  1. Cliquez sur l'icône en forme de cadenas à côté de la barre d'adresse Chrome et rétablissez les paramètres d'autorisation de notification par défaut du site.

  2. Cliquez sur Demander l'autorisation d'envoyer des notifications, puis sélectionnez Bloquer dans le pop-up.

  3. Cliquez sur Envoyer une notification et voyez ce qui se passe. Le texte d'erreur (Could not send notification) et l'objet événement sont enregistrés dans la console.

Vous pouvez éventuellement réinitialiser de nouveau les autorisations de notification du site. Essayez de demander l'autorisation, puis fermez le pop-up plusieurs fois pour voir ce qui se passe.

Tester les options de notification

Vous connaissez maintenant les principes de base de la demande d'autorisation et de l'envoi de notifications. Vous avez également vu l'impact des réponses des utilisateurs sur la capacité de votre application à afficher des notifications.

Vous pouvez maintenant tester les nombreuses options visuelles et de données disponibles lorsque vous créez une notification. Toutes les options disponibles sont disponibles ci-dessous. Pour en savoir plus sur ces options, consultez la documentation sur les notifications sur MDN.

Notez que les navigateurs et les appareils implémentent ces options différemment. Il est donc utile de tester vos notifications sur différentes plates-formes pour voir à quoi elles ressemblent.

let options = {
  dir: 'auto',              // Text direction
  lang: 'en-US',            // A language tag
  badge: '/orange-cat.png', // Display when insufficient room
  body: 'Hello World',      // Body text
  tag: 'mytag',             // Tag for categorization
  icon: '/line-cat.png',    // To display in the notification
  image: '/orange-cat.png', // To display in the notification
  data: {                   // Arbitrary data; any data type
    cheese: 'I like cheese',
    pizza: 'Excellent cheese delivery mechanism',
    arbitrary: {
      faveNumber: 42,
      myBool: true
    }},
  vibrate: [200, 100, 200], // Vibration pattern for hardware
  renotify: false,          // Notify if replaced? Default false
  requireInteraction: false,// Active until click? Default false
  /*
    actions:   // Array of NotificationActions
               // Only usable with a service worker
    [{
      action: 'shop',
      title: 'Shop!',
      icon: '/bags.png'
    },],
  */
}

Pour d'autres idées, reportez-vous au Générateur de notifications de Peter Beverloo.

Si vous êtes bloqué, voici le code final de cet atelier de programmation: glitch.com/edit/#!/codelab-notifications-get-started-completed.

Pour aller plus loin, consultez le prochain atelier de programmation de cette série, Gérer les notifications avec un service worker.