BackgroundFetchUpdateUIEvent.updateUI()
Experimental: これは実験的な機能です。
本番で使用する前にブラウザー互換性一覧表をチェックしてください。
BackgroundFetchUpdateUIEvent インターフェイスの updateUI() メソッドは、 UI 上のタイトルとアイコンを更新し、バックグラウンドのフェッチの成否を表示します。
このメソッドは一度だけ実行され、フェッチの成否をユーザーに通知することができます。
構文
js
updateUI(options)
引数
options省略可-
下記のいずれかを含むオブジェクト。
icons省略可-
UI で用いるアイコンを含む、 1 枚以上の画像リソースのリストです。画像リソースは下記の情報を持つオブジェクトです。
src-
画像のURL文字列。
sizes省略可-
<link>sizes属性と同じ意味を持つ文字列。 type省略可-
画像の MIME タイプを含む文字列。
label省略可-
画像の名前を指定する文字列。
title省略可-
UI の新しいタイトルを指定する文字列。
返値
Promise 。
例外
InvalidStateErrorDOMException-
以下のいずれかに当てはまるとき、発生します。
isTrustedプロパティがfalseのとき。BackgroundFetchUpdateUIEventUI 更新のフラグがすでにセットされている、すなわち、すでにupdateUI()メソッドが呼ばれたあとであるとき。BackgroundFetchUpdateUIEventがアクティブではないとき。
例
以下の例では、フェッチ成功時に UI のタイトルとアイコン画像を更新しています。
js
addEventListener("backgroundfetchsuccess", (event) => {
event.updateUI({
title: "Episode 5 ready to listen!",
icon: {
src: "path/to/success.ico",
sizes: "16x16 32x32 64x64",
},
});
});
仕様書
| Specification |
|---|
| Background Fetch # background-fetch-update-ui-event-update-ui |
ブラウザーの互換性
BCD tables only load in the browser