LaunchQueue: setConsumer() method

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

See full compatibility

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

The setConsumer() method of the LaunchQueue interface is used to declare the callback that will handle custom launch navigation handling in a progressive web app (PWA). Such custom navigation is initiated via Window.launchQueue when a PWA has been launched with a launch_handler client_mode value of focus-existing, navigate-new, or navigate-existing.

Syntax

setConsumer(callback)

Parameters

callback: A callback function that handles custom navigation for the PWA. The callback is passed a LaunchParams object instance as a parameter.

Return value

undefined.

Examples

if ("launchQueue" in window) {
  window.launchQueue.setConsumer((launchParams) => {
    if (launchParams.targetURL) {
      const params = new URL(launchParams.targetURL).searchParams;

      // Assuming a music player app that gets a track passed to it to be played
      const track = params.get("track");
      if (track) {
        audio.src = track;
        title.textContent = new URL(track).pathname.slice(1);
        audio.play();
      }
    }
  });
}

Specifications

Specification
Web App Launch Handler API # dom-launchqueue-setconsumer

Browser compatibility

	desktop					mobile
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox for Android	Opera Android	Safari on iOS	Samsung Internet	WebView Android	WebView on iOS
`setConsumer` Experimental	Chrome – Full support Chrome 102 (Release date: 2022-05-24) footnote Full support	Edge – Full support Edge 102 (Release date: 2022-05-31) footnote Full support	Firefox – No support Firefox footnote No support	Opera – Full support Opera 88 (Release date: 2022-06-08) footnote Full support	Safari – No support Safari footnote No support	Chrome Android – No support Chrome Android footnote No support	Firefox for Android – No support Firefox for Android footnote No support	Opera Android – No support Opera Android footnote No support	Safari on iOS – No support Safari on iOS footnote No support	Samsung Internet – No support Samsung Internet footnote No support	WebView Android – No support WebView Android footnote No support	WebView on iOS – No support WebView on iOS footnote No support

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

Full support: Full support
No support: No support
: Experimental. Expect behavior to change in the future.