chrome.runtime

获取当前扩展程序/应用中正在运行的后台网页的 JavaScript window 对象。如果后台网页是事件页面，系统会确保在调用回调函数前它已经加载。如果没有后台网页，将会设置错误信息。

参数

callback ( function )

callback 参数应该指定一个如下形式的函数：

function(window backgroundPage) {...};

backgroundPage ( optional window )

后台页面的 JavaScript window 对象。

从清单文件中返回有关应用或扩展程序的详情，返回的对象是完整清单文件序列化的结果。

返回值类型的属性

将应用或扩展程序安装目录内的相对路径转换为完全限定的 URL。

参数

path ( string )

指向应用或扩展程序内资源的路径，相对于它的安装目录。

设置卸载时访问的 URL，可以用来清理服务器上的数据、进行分析以及实现调查。最多不能超过 255 个字符。

参数

url ( string )

重新加载应用或扩展程序。

为当前应用/扩展程序请求检查更新。

参数

callback ( function )

callback 参数应该指定一个如下形式的函数：

function(enum of "throttled", "no_update", or "update_available" status, object details) {...};

status ( enum of "throttled", "no_update", or "update_available" )

检查更新的结果。

details ( optional object )

如果更新可用的话，包含有关可用更新的更多信息。

属性

version ( string )

可用更新的版本。

如果应用在信息亭模式下运行，则重新启动 Chrome OS 设备，否则不进行任何操作。

尝试连接到扩展程序/应用中其他的监听者（例如后台网页）或其他扩展程序/应用，该方法对于需要连接到它们的扩展程序进程的内容脚本非常有用。注意，该方法不能连接到内容脚本中的监听者，扩展程序可以通过 tabs.connect 连接到嵌入至标签页中的内容脚本。

参数

extensionId ( optional string )

您需要连接到的扩展程序/应用的标识符，如果省略，默认为您自己的扩展程序。

connectInfo ( optional object )

属性

name ( optional string )

将传递给监听连接事件的扩展程序进程的 onConnect 事件。

includeTlsChannelId ( optional boolean )

TLS 通道标识符是否会传递至 onConnectExternal 事件。

连接到计算机上的原生应用程序。

参数

application ( string )

要连接的已注册应用程序名称。

向扩展程序中的其他监听者（或另一个扩展程序/应用）发送单个请求。与 chrome.runtime.connect 类似，但是只发送具有可选回应的单个请求。onMessage 事件将在扩展程序的每一个页面中产生。注意，扩展程序不能使用该方法向内容脚本发送消息。要向内容脚本发送消息，请使用 tabs.sendMessage。

参数

extensionId ( optional string )

您要连接的扩展程序标识符。如果省略，默认为您自己的扩展程序。

message ( any )

options ( optional object )

属性

includeTlsChannelId ( optional boolean )

TLS 通道标识符是否会传递至 onMessageExternal 事件。

responseCallback ( optional function )

如果您指定了 responseCallback 参数，它应该指定一个如下形式的函数：

function(any response) {...};

response ( any )

消息处理程序发送的 JSON 响应对象。如果连接到扩展程序的过程中发生错误，调用这一回调函数时将不传递参数，并将 lastError 设为错误消息。

向原生应用程序发送单个消息。

参数

application ( string )

原生消息通信宿主的名称。

message ( object )

传递给原生消息通信宿主的消息。

responseCallback ( optional function )

如果您指定了 responseCallback 参数，它应该指定一个如下形式的函数：

function(any response) {...};

response ( any )

原生消息宿主发送的响应消息。如果连接到原生消息宿主的过程中发生错误，调用回调函数时不会传递参数，同时 lastError 将设置为错误消息。

返回有关当前平台的信息。

参数

callback ( function )

调用时返回结果。

callback 参数应该指定一个如下形式的函数：

function(object platformInfo) {...};

platformInfo ( object )

属性

os ( enum of "mac", "win", "android", "cros", "linux", or "openbsd" )

当前运行 Chrome 浏览器的操作系统。

arch ( enum of "arm", "x86-32", or "x86-64" )

计算机的处理器架构。

nacl_arch ( enum of "arm", "x86-32", or "x86-64" )

Native Client 架构，在某些平台上可能和 arch 不同。

返回包目录对应的 DirectoryEntry（目录项）。

参数

callback ( function )

callback 参数应该指定一个如下形式的函数：

function(directoryentry directoryEntry) {...};

directoryEntry ( directoryentry )

当安装了该扩展程序的配置文件第一次启动时产生。即使扩展程序以“分离式”隐身模式运行，启动隐身配置文件时也不会产生该事件。

function() {...};

当扩展程序第一次安装、更新至新版本或 Chrome 浏览器更新至新版本时产生。

function(object details) {...};

在事件页面即将卸载前发送，这样扩展程序就有机会进行清理。注意，由于页面即将卸载，处理该事件时开始的任何异步操作都不能保证完成。如果卸载前事件页面产生了更多活动，将产生 onSuspendCanceled 事件，并且事件页面不会卸载。

function() {...};

在 onSuspend 之后发送，表示应用最终不会被卸载。

function() {...};

当更新可用时产生，然而由于应用当前还在运行，不能立即安装。如果您什么都不做，更新将在后台网页下一次卸载时安装。如果您希望快点安装，您可以显式调用 reload。

function(object details) {...};

当 Chrome 浏览器的更新可用，但是由于需要浏览器重新启动而没有立即安装时产生。

function() {...};

当连接从扩展程序进程或内容脚本中发起时产生。

function(Port port) {...};

当连接从另一个扩展程序发起时产生。

function(Port port) {...};

当消息从扩展程序进程或者内容脚本中发送时产生。

function(any message, MessageSender sender, function sendResponse) {...};

监听器返回值

( boolean )

如果您需要在事件监听器返回后再调用 sendResponse 请在事件监听器中返回 true。

当消息从另一个扩展程序/应用发送时产生。不能在内容脚本中使用。

function(any message, MessageSender sender, function sendResponse) {...};

监听器返回值

( boolean )

如果您需要在事件监听器返回后再调用 sendResponse 请在事件监听器中返回 true。

应用或者运行它的设备需要重新启动时产生，应用应该尽早关闭所有窗口，以便开始重新启动。如果应用什么都不做，超过 24 小时的宽限期后会强制重新启动。目前，只有 Chrome OS 的 Kiosk 应用会产生该事件。

function(enum of "app_update", "os_update", or "periodic" reason) {...};