webNavigation.onReferenceFragmentUpdated

当页面的片段标识符更改时触发。例如,如果一个页面使用片段实现了目录,并且用户点击了目录中的一个条目,就会触发此事件。此框架的所有后续事件都将使用更新后的 URL。

语法

js
browser.webNavigation.onReferenceFragmentUpdated.addListener(
  listener,                   // function
  filter                      // optional object
)
browser.webNavigation.onReferenceFragmentUpdated.removeListener(listener)
browser.webNavigation.onReferenceFragmentUpdated.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。片段标识符更改页面的时间,以自纪元以来的毫秒数为单位。

transitionType

transitionType。导航的原因:例如,如果是用户点击链接,则为"link"

transitionQualifiers

Array of transitionQualifier。有关导航的附加信息:例如,是否存在服务器端或客户端重定向。

示例

onReferenceFragmentUpdated 记录目标 URL 和额外的过渡信息,前提是目标 URL 的主机名包含 "example.com" 或以 "developer" 开头。

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

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

browser.webNavigation.onReferenceFragmentUpdated.addListener(
  logOnReferenceFragmentUpdated,
  filter,
);

浏览器兼容性

注意:此API基于Chromium的chrome.webNavigation API。本文档源自Chromium代码中的web_navigation.json