BeforeInstallPromptEvent: prompt() メソッド
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Experimental: これは実験的な機能です。
本番で使用する前にブラウザー互換性一覧表をチェックしてください。
非標準: この機能は標準化されていません。非標準の機能はブラウザーの対応が限られ、将来的に変更または削除される可能性があるため、本番環境での使用は推奨されません。ただし、標準の選択肢が存在しない特定のケースでは、有効な代替手段となる場合があります。
prompt() は BeforeInstallPromptEvent インターフェイスのメソッドで、開発者が任意の時点でインストールプロンプトを表示させることができるようにします。通常、これはアプリの独自のインストール UI のイベントハンドラー内で呼び出されます。
このメソッドは、ユーザー操作（ボタンのクリックなど）に対するイベントハンドラー内で呼び出す必要があり、指定された BeforeInstallPromptEvent インスタンスに対しては一度だけ呼び出すことができます。
構文
prompt()
引数
なし。
返値
Promise で、以下のプロパティを持つオブジェクトに解決します。
outcome-
ユーザーがアプリのインストールを選択したかどうかを示す文字列です。以下のいずれかの値のどちらかになります。
"accepted": ユーザーがアプリをインストールした。"dismissed": ユーザーがアプリをインストールしなかった。
platform-
ユーザーがアプリのインストールを選択した場合、これは選択されたプラットフォームの名前を表す文字列であり、
BeforeInstallPromptEvent.platformsプロパティの値のいずれかになります。ユーザーがアプリのインストールをしないことを選択した場合、これは空文字列になります。
例
BeforeInstallPromptEvent インターフェイスの例を参照してください。
ブラウザーの互換性
関連情報
- PWA をインストール可能にする
- How to provide your own in-app install experience - web.dev (2021)