webNavigation.onHistoryStateUpdated

語法

browser.webNavigation.onHistoryStateUpdated.addListener(
  listener,                   // function
  filter                      // optional object
)
browser.webNavigation.onHistoryStateUpdated.removeListener(listener)
browser.webNavigation.onHistoryStateUpdated.hasListener(listener)

事件有三個函式

addListener(listener)

向此事件新增監聽器。

removeListener(listener)

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

hasListener(listener)

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

addListener 語法

引數

監聽器

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

details

object。有關導航事件的詳細資訊。有關更多資訊，請參閱詳細資訊部分。

filter 可選

object。一個包含單個屬性url的物件，該屬性是一個Array，其中包含events.UrlFilter物件。如果您包含此引數，則僅在導航到至少一個與陣列中的UrlFilter匹配的URL時才會觸發該事件。如果省略此引數，則在所有導航時都會觸發該事件。

額外物件

details

tabId

integer。導航即將發生的選項卡ID。

url

string。給定框架將導航到的URL。

processId 可選 已棄用

integer。此值在現代瀏覽器中未設定。當設定時，它代表執行此選項卡渲染器的程序ID。

frameId

integer。導航將發生的框架。0表示導航發生在選項卡的主瀏覽上下文，而不是巢狀的<iframe>中。正值表示導航發生在巢狀的iframe中。對於給定的選項卡和程序，框架ID是唯一的。

parentFrameId

integer。此框架父級的ID。如果這是頂層框架，則設定為-1。

timeStamp

number。History API 更改 URL 的時間，以毫秒（自紀元起）為單位。

transitionType

transitionType。導航的原因：例如，如果使用者點選了連結，則為 "link"。

transitionQualifiers

Array of transitionQualifier。有關導航的附加資訊：例如，是否存在伺服器端或客戶端重定向。

示例

如果目標 URL 的主機名包含 "example.com" 或以 "developer" 開頭，則記錄 onHistoryStateUpdated 的目標 URL 和額外的導航資訊。

const filter = {
  url: [{ hostContains: "example.com" }, { hostPrefix: "developer" }],
};

function logOnHistoryStateUpdated(details) {
  console.log(`onHistoryStateUpdated: ${details.url}`);
  console.log(`Transition type: ${details.transitionType}`);
  console.log(`Transition qualifiers: ${details.transitionQualifiers}`);
}

browser.webNavigation.onHistoryStateUpdated.addListener(
  logOnHistoryStateUpdated,
  filter,
);

瀏覽器相容性