runtime.onUpdateAvailable

當擴充套件程式有可用更新時觸發。此事件允許擴充套件程式延遲更新:例如,因為它正處於不應中斷的某個操作的中間。

如果擴充套件程式在有可用更新時未監聽此事件,則擴充套件程式會立即重新載入並應用更新。如果擴充套件程式正在監聽,則在下次重新載入擴充套件程式時將應用更新。這發生在以下情況:

  • 瀏覽器重啟
  • 擴充套件程式被停用然後重新啟用
  • 擴充套件程式透過呼叫 runtime.reload() 顯式重新載入自身。

語法

js
browser.runtime.onUpdateAvailable.addListener()
browser.runtime.onUpdateAvailable.removeListener(listener)
browser.runtime.onUpdateAvailable.hasListener(listener)

事件有三個函式

addListener(listener)

向此事件新增監聽器。

removeListener(listener)

停止監聽此事件。listener 引數是要移除的監聽器。

hasListener(listener)

檢查此事件是否已註冊 listener。如果正在偵聽,則返回 true,否則返回 false

addListener 語法

引數

監聽器

當此事件發生時呼叫的函式。該函式將傳遞此引數

details

object。包含一個名為 version 的單個屬性,該屬性是字串,表示更新的版本號。

示例

監聽 UpdateAvailable 事件

js
function handleUpdateAvailable(details) {
  console.log(details.version);
  // Proceed to upgrade the add-on
  browser.runtime.reload();
}

browser.runtime.onUpdateAvailable.addListener(handleUpdateAvailable);

瀏覽器相容性

注意:此 API 基於 Chromium 的 chrome.runtime API。本文件來源於 Chromium 程式碼中的 runtime.json