runtime
此模块提供有关您的扩展及其运行环境的信息。
它还提供消息传递 API,使您能够
- 在扩展的不同部分之间进行通信。有关在消息传递选项之间进行选择方面的建议,请参阅 在一次性消息和基于连接的消息传递之间进行选择。
- 与其他扩展进行通信。
- 与原生应用程序进行通信。
类型
runtime.Port
-
表示两个特定上下文之间连接的一端,可用于交换消息。
runtime.MessageSender
-
包含有关消息或连接请求发送者的信息。
runtime.PlatformOs
-
标识浏览器的操作系统。
runtime.PlatformArch
-
标识浏览器的处理器架构。
runtime.PlatformInfo
-
包含有关浏览器运行平台的信息。
runtime.RequestUpdateCheckStatus
-
对
runtime.requestUpdateCheck()
的调用的结果。 runtime.OnInstalledReason
-
分派
runtime.onInstalled
事件的原因。 runtime.OnPerformanceWarningCategory
-
分派
runtime.onPerformanceWarning
事件的警告类别。 runtime.OnPerformanceWarningSeverity
-
分派
runtime.onPerformanceWarning
事件的警告严重程度。 runtime.OnRestartRequiredReason
-
分派
runtime.onRestartRequired
事件的原因。
属性
runtime.lastError
-
当异步函数具有需要向其调用者报告的错误条件时,将设置此值。
runtime.id
-
扩展的 ID。
函数
runtime.getBackgroundPage()
-
检索在当前扩展程序内运行的后台页面的 Window 对象。
runtime.openOptionsPage()
-
打开扩展程序的 选项页面。
runtime.getContexts()
-
获取有关与扩展程序关联的上下文的信息。
runtime.getFrameId()
-
获取任何窗口全局或框架元素的框架 ID。
runtime.getManifest()
-
获取完整的 manifest.json 文件,序列化为对象。
runtime.getURL()
-
给定从 manifest.json 到与扩展程序打包的资源的相对路径,返回一个完全限定的 URL。
runtime.setUninstallURL()
-
设置卸载扩展程序时要访问的 URL。
runtime.reload()
-
重新加载扩展程序。
runtime.requestUpdateCheck()
-
检查此扩展程序的更新。
runtime.connect()
-
从内容脚本到主扩展程序进程建立连接,或从一个扩展程序到另一个扩展程序建立连接。
runtime.connectNative()
-
将扩展程序连接到用户计算机上的原生应用程序。
runtime.sendMessage()
-
向扩展程序或其他扩展程序内的事件侦听器发送单个消息。类似于
runtime.connect
,但仅发送单个消息,并带有一个可选的响应。 runtime.sendNativeMessage()
-
从扩展程序向原生应用程序发送单个消息。
runtime.getPlatformInfo()
-
返回有关当前平台的信息。
runtime.getBrowserInfo()
-
返回有关安装此扩展程序的浏览器的信息。
runtime.getPackageDirectoryEntry()
-
返回包目录的 DirectoryEntry。
事件
runtime.onStartup
-
安装了此扩展程序的配置文件首次启动时触发。启动隐身模式配置文件时不会触发此事件。
runtime.onInstalled
-
扩展程序首次安装时、扩展程序更新到新版本时以及浏览器更新到新版本时触发。
runtime.onSuspend
-
在扩展程序卸载之前发送到事件页面。这使扩展程序有机会进行一些清理工作。
runtime.onSuspendCanceled
-
在
runtime.onSuspend
之后发送,指示扩展程序最终不会卸载。 runtime.onUpdateAvailable
-
有更新可用但未立即安装时触发,因为扩展程序当前正在运行。
runtime.onBrowserUpdateAvailable
已弃用-
浏览器更新可用但未立即安装时触发,因为需要重新启动浏览器。
runtime.onConnect
-
与扩展程序进程或内容脚本建立连接时触发。
runtime.onConnectExternal
-
与另一个扩展程序建立连接时触发。
runtime.onMessage
-
扩展程序进程或内容脚本发送消息时触发。
runtime.onMessageExternal
-
另一个扩展程序发送消息时触发。不能在内容脚本中使用。
runtime.onPerformanceWarning
-
检测到扩展程序的运行时性能问题时触发。
runtime.onRestartRequired
-
设备需要重新启动时触发。
浏览器兼容性
BCD 表仅在浏览器中加载
示例扩展
- beastify
- content-script-register
- cookie-bg-picker
- devtools-panels
- export-helpers
- favourite-colour
- find-across-tabs
- imagify
- menu-demo
- mocha-client-tests
- native-messaging
- notify-link-clicks-i18n
- permissions
- runtime-examples
- store-collected-images
- user-script-register
- webpack-modules
注意:此 API 基于 Chromium 的 chrome.runtime
API。此文档源自 Chromium 代码中的 runtime.json
。