Clients

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since April 2018.

L'interface Clients permet d'accéder aux objets Client. On y accède via self.clients au sein d'un service worker.

Méthodes

Clients.get()

Retourne une Promise (« Promesse ») pour un Client correspondant à un id donné.

Clients.matchAll()

Retourne une Promise (« Promesse ») pour un tableau d'objets Client. L'argument options vous permet de contrôler les types de clients renvoyés.

Clients.openWindow()

Ouvre une nouvelle fenêtre de navigateur pour une url donnée et renvoie une Promise (« Promesse ») pour le nouveau WindowClient.

Clients.claim()

Permet à un service worker actif de se définir comme le controller (« Controlleur ») pour tous les clients dans son scope (« sa portée »).

Exemple

L'exemple suivant montre une fenêtre de chat existante ou en crée une nouvelle lorsque l'utilisateur clique sur une notification.

js
addEventListener("notificationclick", (event) => {
  event.waitUntil(
    (async function () {
      const allClients = await clients.matchAll({
        includeUncontrolled: true,
      });

      let chatClient;

      // Voyons si nous avons déjà une fenêtre de discussion ouverte :
      for (const client of allClients) {
        const url = new URL(client.url);

        if (url.pathname == "/chat/") {
          // Excellent, utilisons-la !
          client.focus();
          chatClient = client;
          break;
        }
      }

      // Si nous n'avons pas trouvé de fenêtre de discussion existante,
      // ouvrons-en une nouvelle :
      if (!chatClient) {
        chatClient = await clients.openWindow("/chat/");
      }

      // Envoyez un message au client :
      chatClient.postMessage("Nouveaux messages !");
    })(),
  );
});

Spécifications

Specification
Service Workers
# clients-interface

Compatibilité des navigateurs

Voir aussi