webNavigation.onBeforeNavigate

语法

browser.webNavigation.onBeforeNavigate.addListener(
  listener,                   // function
  filter                      // optional object
)
browser.webNavigation.onBeforeNavigate.removeListener(listener)
browser.webNavigation.onBeforeNavigate.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。浏览器即将开始导航的时间，单位为 自纪元以来的毫秒数。

示例

如果目标主机名包含 "example.com" 或以 "developer" 开头，则记录 onBeforeNavigate 的目标 URL。

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

function logOnBefore(details) {
  console.log(`onBeforeNavigate to: ${details.url}`);
}

browser.webNavigation.onBeforeNavigate.addListener(logOnBefore, filter);

浏览器兼容性