chrome.management
描述: |
chrome.management API 可以用来管理已经安装并且正在运行的扩展程序或应用,它对于替代内建的“打开新的标签页”页面的扩展程序特别有用。
|
可用版本: |
从 Chrome 8 开始稳定支持。
|
权限: |
"management"
|
类型
IconInfo
属于扩展程序、应用或主题背景的图标的有关信息。
-
size
(
integer
)
-
代表图标宽度和高度的一个整数,可能的值包括(但不限于)128、48、24 和 16。
-
url
(
string
)
-
该图标图像的 URL。要显示一个灰度版本的图标(例如表示扩展程序已禁用),请在 URL 后附加
?grayscale=true
。
ExtensionInfo
已安装的扩展程序、应用或主题背景的有关信息。
-
id
(
string
)
-
扩展程序的唯一标识符。
-
name
(
string
)
-
扩展程序、应用或主题背景的名称。
-
shortName
(
string
)
-
扩展程序、应用或主题背景名称的简短版本。
-
description
(
string
)
-
扩展程序、应用或主题背景的描述。
-
version
(
string
)
-
扩展程序、应用或主题背景的版本。
-
mayDisable
(
boolean
)
-
用户是否能禁用或卸载该扩展程序。
-
enabled
(
boolean
)
-
该扩展程序当前是否已启用。
-
disabledReason
(
optional
enum of "unknown"
, or "permissions_increase"
)
-
项目被禁用的原因。
-
type
(
enum of "extension"
, "hosted_app"
, "packaged_app"
, "legacy_packaged_app"
, or "theme"
)
-
该扩展程序、应用或主题背景的类型。
-
appLaunchUrl
(
optional
string
)
-
用于执行的 URL(仅在应用中存在)。
-
homepageUrl
(
optional
string
)
-
该扩展程序、应用或主题背景的主页 URL。
-
updateUrl
(
optional
string
)
-
该扩展程序、应用或主题背景的更新 URL。
-
offlineEnabled
(
boolean
)
-
该扩展程序、应用或主题背景是否声明它具有离线支持。
-
optionsUrl
(
string
)
-
该项目的选项页面 URL(如果有的话)。
-
icons
(
optional
array of IconInfo
)
-
图标信息列表。注意这只反映声明在清单文件中的信息,URL 指定的实际图像可能比声明的更大或更小,所以您引用这些图像时可能要考虑在 标签中显式使用 width 和 height 属性。有关更多细节,请参见清单文件:icons。
-
permissions
(
array of string
)
-
返回 API 权限列表。
-
hostPermissions
(
array of string
)
-
返回主机权限列表。
-
installType
(
enum of "admin"
, "development"
, "normal"
, "sideload"
, or "other"
)
-
扩展程序是如何安装的,为下列值之一:
"admin" 表示扩展程序由于管理策略而安装;
"development" 表示扩展程序以未打包形式在开发者模式下加载;
"normal" 表示扩展程序由 .crx 文件正常安装;
"sideload" 表示扩展程序由计算机上的其他软件安装;
"other" 表示扩展程序通过其他方式安装。
方法
getAll
chrome.management.getAll(function callback)
返回已安装的扩展程序和应用的信息列表。
参数
-
callback
(
optional
function
)
-
如果您指定了 callback 参数,它应该指定一个如下形式的函数:
function(array of ExtensionInfo result) {...};
get
chrome.management.get(string id, function callback)
返回已安装且具有指定标识符的扩展程序、应用或主题背景的有关信息。
参数
-
callback
(
optional
function
)
-
如果您指定了 callback 参数,它应该指定一个如下形式的函数:
function(ExtensionInfo result) {...};
getPermissionWarningsById
chrome.management.getPermissionWarningsById(string id, function callback)
返回指定扩展程序标识符所对应的权限警告列表。
参数
-
id
(
string
)
-
已安装的扩展程序的标识符。
-
callback
(
optional
function
)
-
如果您指定了 callback 参数,它应该指定一个如下形式的函数:
function(array of string permissionWarnings) {...};
-
permissionWarnings
(
array of string
)
-
getPermissionWarningsByManifest
chrome.management.getPermissionWarningsByManifest(string manifestStr, function callback)
返回指定扩展程序清单文件字符串对应的权限警告列表。注意,这一函数不需要在清单文件中请求 "management"(管理)权限就可以使用。
参数
-
manifestStr
(
string
)
-
扩展程序清单文件的 JSON 字符串。
-
callback
(
optional
function
)
-
如果您指定了 callback 参数,它应该指定一个如下形式的函数:
function(array of string permissionWarnings) {...};
-
permissionWarnings
(
array of string
)
-
setEnabled
chrome.management.setEnabled(string id, boolean enabled, function callback)
启用或禁用一个应用或扩展程序。
参数
-
enabled
(
boolean
)
-
应该启用还是禁用该项目。
-
callback
(
optional
function
)
-
如果您指定了 callback 参数,它应该指定一个如下形式的函数:
function() {...};
uninstall
chrome.management.uninstall(string id, object options, function callback)
卸载当前已安装的某个应用或扩展程序。
参数
-
options
(
optional
object
)
-
-
属性
-
showConfirmDialog
(
optional
boolean
)
-
是否显示确认卸载对话框提示用户,默认为 false。
-
callback
(
optional
function
)
-
如果您指定了 callback 参数,它应该指定一个如下形式的函数:
function() {...};
uninstallSelf
chrome.management.uninstallSelf(object options, function callback)
卸载调用该方法的扩展程序。注意,这一函数不需要在清单文件中请求 "management"(管理)权限就可以使用。
参数
-
options
(
optional
object
)
-
-
属性
-
showConfirmDialog
(
optional
boolean
)
-
是否显示确认卸载对话框提示用户,默认为 false。
-
callback
(
optional
function
)
-
如果您指定了 callback 参数,它应该指定一个如下形式的函数:
function() {...};
launchApp
chrome.management.launchApp(string id, function callback)
运行一个应用。
参数
-
id
(
string
)
-
应用的扩展程序标识符。
-
callback
(
optional
function
)
-
如果您指定了 callback 参数,它应该指定一个如下形式的函数:
function() {...};
事件
onInstalled
安装应用或扩展程序时产生。
addListener
chrome.management.onInstalled.addListener(function callback)
onUninstalled
应用或扩展程序卸载时产生。
addListener
chrome.management.onUninstalled.addListener(function callback)
参数
callback 参数应该指定一个如下形式的函数:
function(string id) {...};
-
id
(
string
)
-
卸载的扩展程序、应用或主题背景的标识符。
onEnabled
应用或扩展程序启用时产生。
addListener
chrome.management.onEnabled.addListener(function callback)
onDisabled
应用或扩展程序禁用时产生。
addListener
chrome.management.onDisabled.addListener(function callback)