Back to Content

Window: launchQueue property

files/en-us/web/api/window/launchqueue/index.md

latest1.6 KB
Original Source

{{APIRef("Launch Handler API")}}{{SeeCompatTable}}

The launchQueue read-only property of the {{domxref("Window")}} interface provides access to the {{domxref("LaunchQueue")}} class, which allows custom launch navigation handling to be implemented in a progressive web app (PWA), with the handling context signified by the launch_handler manifest field client_mode value.

The custom launch navigation handling functionality is controlled by the properties of the {{domxref("LaunchParams")}} object passed into the {{domxref("LaunchQueue.setConsumer()")}} callback function.

Value

A {{domxref("LaunchQueue")}} object instance.

Examples

js
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.substring(1);
        audio.play();
      }
    }
  });
}

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also