LaunchQueue: setConsumer() メソッド

Limited availability

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

Experimental: これは実験的な機能です。
本番で使用する前にブラウザー互換性一覧表をチェックしてください。

setConsumer() は LaunchQueue インターフェイスのメソッドで、プログレッシブウェブアプリ (PWA) でカスタム起動ナビゲーション処理を処理するコールバックを宣言するために使用されます。このようなカスタムナビゲーションは、 PWA が launch_handler の client_mode の値が focus-existing, navigate-new, navigate-existing のいずれかの設定で起動した場合に、 Window.launchQueue を通じて実行されます。

構文

js
setConsumer(callback)

引数

callback

PWA のカスタムナビゲーションを処理するコールバック関数。コールバックには、 LaunchParams オブジェクトのインスタンスが引数として渡されます。

返値

undefined です。

例

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

      // 再生するトラックを受け取る音楽プレーヤーアプリを想定
      const track = params.get("track");
      if (track) {
        audio.src = track;
        title.textContent = new URL(track).pathname.substr(1);
        audio.play();
      }
    }
  });
}

仕様書

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

ブラウザーの互換性

BCD tables only load in the browser

関連情報