chrome.webstore

描述 使用 chrome.webstore API 在您的网站上“内嵌”安装应用与扩展程序。
可用版本 从 Chrome 15 开始支持。
了解更多 使用内嵌安装

摘要

类型
InstallStage
ErrorCode
方法
install chrome.webstore.install(string url, function successCallback, function failureCallback)
事件
onInstallStageChanged
onDownloadProgress

类型

InstallStage

从 Chrome 35 开始支持。

表示安装阶段的枚举值,'downloading' 表示正在下载所需文件,'installing' 表示下载的文件正在安装。
枚举
"installing", or "downloading"

ErrorCode

从 Chrome 38 开始支持。警告:目前为 Dev 分支。了解更多内容

可能的安装结果,包括内嵌安装失败后事件中发回的错误代码。
枚举
"otherError", "aborted", "installInProgress", "notPermitted", "invalidId", "webstoreRequestError", "invalidWebstoreResponse", "invalidManifest", "iconError", "userCanceled", "blacklisted", "missingDependencies", "requirementViolations", "blockedByPolicy", "launchFeatureDisabled", "launchUnsupportedExtensionType", or "launchInProgress"

方法

install

chrome.webstore.install(string url, function successCallback, function failureCallback)
参数
string (可选)
url

如果您的网页中包含多于一个关系为 chrome-webstore-item<link> 标签,您可以在这里传递 URL 选择您希望安装的项目。如果省略的话,则使用第一个(或唯一一个)链接。如果传递的 URL 在页面中不存在则会引发异常。

function (可选)
successCallback

当内嵌安装成功完成时(已经显示确认对话框并且用户同意将该项目添加至 Chrome 浏览器)调用此函数。您可以使用它隐藏提示用户安装应用程序或扩展程序的用户界面元素。

function (可选)
failureCallback

内嵌安装没有成功完成时调用此函数。可能的原因包括用户取消了确认对话框,链接的项目无法在网上应用店中找到,或者安装由未经过验证的站点进行。

如果您指定了 failureCallback 参数,它应该是一个如下形式的函数:

function(string error, ErrorCode errorCode) {...};
string error

失败的详情。您可以为调试目的检查或记录它,但是您不应该依赖于传递过来的特定字符串。

ErrorCode (可选)
errorCode

错误代码,来自稳定的可能错误列表。

事件

onInstallStageChanged

从 Chrome 35 开始支持。

内嵌安装进入新的安装阶段时产生。为了接收该事件的通知,您应该在内嵌安装开始前注册监听器。

addListener

chrome.webstore.onInstallStageChanged.addListener(function callback)
参数
function callback

callback 参数应该是一个如下形式的函数:

function( InstallStage stage) {...};
InstallStage stage

刚刚开始的安装阶段。

onDownloadProgress

从 Chrome 35 开始支持。

内嵌安装下载过程中周期性地产生该事件。为了接收该事件的通知,您应该在内嵌安装开始前注册监听器。

addListener

chrome.webstore.onDownloadProgress.addListener(function callback)
参数
function callback

callback 参数应该是一个如下形式的函数:

function(double percentDownloaded) {...};
double percentDownloaded

下载进度,在 0~1 之间,0 表示还没开始,1.0 表示已经完成。