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 PromisePromesse ») pour un Client correspondant à un id donné.

Clients.matchAll()

Retourne une PromisePromesse ») 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 PromisePromesse ») pour le nouveau WindowClient.

Clients.claim()

Permet à un service worker actif de se définir comme le controllerControlleur ») pour tous les clients dans son scopesa 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

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
Clients
claim
get
matchAll
options.includeUncontrolled parameter
openWindow

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
Partial support
Partial support
No support
No support
See implementation notes.
Has more compatibility info.

Voir aussi