LaunchQueue: setConsumer() method
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
js
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
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.substr(1);
audio.play();
}
}
});
}
Specifications
Specification |
---|
Web App Launch Handler API # dom-launchqueue-setconsumer |
Browser compatibility
BCD tables only load in the browser