W3cubDocs

/DOM

Clients

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The Clients interface provides access to Client objects. Access it via self.clients within a service worker.

Methods

Clients.get()
Returns a Promise for a Client matching a given id.
Clients.matchAll()
Returns a Promise for an array of Client objects. An options argument allows you to control the types of clients returned.
Clients.openWindow()
Opens a new browser window for a given url and returns a Promise for the new WindowClient.
Clients.claim()
Allows an active service worker to set itself as the controller for all clients within its scope.

Examples

The following example shows an existing chat window or creates a new one when the user clicks a notification.

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

    let chatClient;

    // Let's see if we already have a chat window open:
    for (const client of allClients) {
      const url = new URL(client.url);

      if (url.pathname == '/chat/') {
        // Excellent, let's use it!
        client.focus();
        chatClient = client;
        break;
      }
    }

    // If we didn't find an existing chat window,
    // open a new one:
    if (!chatClient) {
      chatClient = await clients.openWindow('/chat/');
    }

    // Message the client:
    chatClient.postMessage("New chat messages!");
  }());
});

Specifications

Specification Status Comment
Service Workers
The definition of 'Clients' in that specification.
Working Draft Initial definition

Browser compatibilityUpdate compatibility data on GitHub

Desktop
Chrome Edge Firefox Internet Explorer Opera Safari
Basic support 40 ? 44
44
Service workers (and Push) have been disabled in the Firefox 45 & 52 Extended Support Releases (ESR).
No 27 No
claim 42 ? 44
44
Service workers (and Push) have been disabled in the Firefox 45 & 52 Extended Support Releases (ESR).
No 29 No
get 51 ? 45
45
Service workers (and Push) have been disabled in the Firefox 45 & 52 Extended Support Releases (ESR).
No 38 No
matchAll 47
47
Client objects returned in most recent focus order.
? 44
44
Service workers (and Push) have been disabled in the Firefox 45 & 52 Extended Support Releases (ESR).
54
Client objects returned in most recent focus order.
No 32 No
openWindow 40
40
42
Can only open URLs on the same origin.
43
Can open any URL.
51
URLs may open inside an existing browsing context provided by a standalone web app
? 45
45
Service workers (and Push) have been disabled in the Firefox 45 & 52 Extended Support Releases (ESR).
No 38 No
Mobile
Android webview Chrome for Android Edge Mobile Firefox for Android Opera for Android iOS Safari Samsung Internet
Basic support 40 40 ? 44 27 No 4.0
claim 42 42 ? 44 29 No 4.0
get No 51 ? 45 38 No 5.0
matchAll 47
47
Client objects returned in most recent focus order.
47
47
Client objects returned in most recent focus order.
? 44
44
54
Client objects returned in most recent focus order.
32 No 4.0
openWindow 40
40
42
Can only open URLs on the same origin.
43
Can open any URL.
51
URLs may open inside an existing browsing context provided by a standalone web app
40
40
42
Can only open URLs on the same origin.
43
Can open any URL.
51
URLs may open inside an existing browsing context provided by a standalone web app
? 45 38 No 4.0
4.0
5.0
URLs may open inside an existing browsing context provided by a standalone web app

See also

© 2005–2018 Mozilla Developer Network and individual contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/Clients