chrome.management

Description

chrome.management API 提供了管理已安装和运行的扩展程序/应用程序列表的方法。它对于覆盖内置新标签页的扩展特别有用。

Permissions

management

# Manifest(清单)

您必须在扩展清单中声明“管理”权限才能使用管理 API。例如：

{
  "name": "My extension",
  ...
  "permissions": [
    "management"
  ],
  ...
}

management.getPermissionWarningsByManifest、management.uninstallSelf 和 management.getSelf 不需要管理权限。

Summary

Types
Methods
Events

Types

ExtensionDisabledReason

Chrome 44+

项目被禁用的原因。

TYPE

"unknown", or "permissions_increase"

ExtensionInfo

有关已安装扩展程序、应用程序或主题的信息。

PROPERTIES

appLaunchUrl

​ string optional

启动网址（仅适用于应用程序）

availableLaunchTypes

​ LaunchType[] optional

当前可用的启动类型（仅适用于应用程序）。

description

​ string

此扩展程序、应用程序或主题的描述。

disabledReason

​ ExtensionDisabledReason optional

项目被禁用的原因。

enabled

​ boolean

它当前是启用还是禁用。

homepageUrl

​ string optional

此扩展程序、应用程序或主题的主页 URL。

hostPermissions

​ string[]

返回基于主机的权限列表。

icons

​ IconInfo[] optional

图标信息列表。请注意，这仅反映清单中声明的内容，该 url 上的实际图像可能大于或小于声明的内容，所以你可以考虑在引用这些图像的 img 标签上使用显式的宽度和高度属性。有关更多详细信息，请参阅有关图标的清单文档。

id

​ string

扩展的唯一标识符。

installType

​ ExtensionInstallType

扩展程序是如何安装的。

isApp

​ boolean

已弃用

请使用 management.ExtensionInfo.type。

如果这是一个应用程序，则为真。

launchType

​ LaunchType optional

应用程序启动类型（仅适用于应用程序）。

mayDisable

​ boolean

用户是否可以禁用或卸载此扩展程序。

mayEnable

​ boolean optional

Chrome 62+

用户是否可以启用此扩展。这仅针对未启用的扩展返回。

name

​ string

此扩展程序、应用程序或主题的名称。

offlineEnabled

​ boolean

扩展程序、应用程序或主题是否声明支持离线。

optionsUrl

​ string

项目选项页面的 url，如果有的话。

permissions

​ string[]

返回基于 API 的权限列表。

shortName

​ string

此扩展程序、应用程序或主题名称的简短版本。

type

​ ExtensionType

此扩展程序、应用程序或主题的类型。

updateUrl

​ string optional

此扩展程序、应用程序或主题的更新 URL。

version

​ string

此扩展程序、应用程序或主题的版本

versionName

​ string optional

Chrome 50+

如果清单指定了此扩展程序、应用程序或主题的版本名称。

ExtensionInstallType

Chrome 44+

扩展程序是如何安装的。admin之一：由于管理策略安装了扩展，development：在开发者模式下解压加载扩展，normal：扩展是通过 .crx 文件正常安装的，sideload：扩展是由机器上的其他软件安装的，other：扩展是通过其他方式安装的。

TYPE

"admin", "development", "normal", "sideload", or "other"

ExtensionType

Chrome 44+

此扩展程序、应用程序或主题的类型。

TYPE

"extension", "hosted_app", "packaged_app", "legacy_packaged_app", "theme", or "login_screen_extension"

IconInfo

有关属于扩展程序、应用程序或主题的图标的信息。

PROPERTIES

size

​ number

代表图标宽度和高度的数字。可能的值包括（但不限于）128、48、24 和 16。

url

​ string

此图标图像的 URL。要显示图标的灰度版本（例如，指示扩展程序已禁用），请将 ?grayscale=true 附加到 URL。

LaunchType

这些都是可能的应用程序启动类型。

TYPE

"OPEN_AS_REGULAR_TAB", "OPEN_AS_PINNED_TAB", "OPEN_AS_WINDOW", or "OPEN_FULL_SCREEN"

UninstallOptions

Chrome 88+

如何处理扩展卸载的选项。

PROPERTIES

showConfirmDialog

​ boolean optional

确认卸载对话框是否应提示用户。对于自我卸载，默认为 false。如果扩展卸载了另一个扩展，则忽略此参数并始终显示对话框。

Methods

canInstallReplacementAndroidApp

chrome.management.canInstallReplacementAndroidApp( callback?: function, )

Promise In development

检查是否可以安装替换的 android 应用程序。此 API 产生的错误通过设置 runtime.lastError 并执行函数的常规回调来报告。

PARAMETERS

callback

​ function optional

回调参数如下所示：

(result: boolean) => void

  • result

    ​ boolean

RETURNS

Promise<boolean>

这仅在未指定callback参数时返回 Promise，并且使用 MV3+。 Promise 中的类型与callback的第一个参数相同。

createAppShortcut

chrome.management.createAppShortcut( id: string, callback?: function, )

Promise

显示用于为应用程序创建快捷方式的选项。在 Mac 上，只能创建打包的应用程序快捷方式。

PARAMETERS

id

​ string

这应该是来自 management.ExtensionInfo 的应用程序项的 ID。

callback

​ function optional

回调参数如下所示：

() => void

RETURNS

Promise<void>

Pending

这仅在未指定callback参数时返回 Promise，并且使用 MV3+。 Promise 中的类型与callback的第一个参数相同。

chrome.management.generateAppForLink( url: string, title: string, callback?: function, )

Promise

为 URL 生成应用程序。返回生成的书签应用程序。

PARAMETERS

url

​ string

网页的 URL。 URL的scheme只能是“http”或“https”。

title

​ string

生成的应用程序的标题。

callback

​ function optional

回调参数如下所示：

(result: ExtensionInfo) => void

RETURNS

Promise<ExtensionInfo>

Pending

这仅在未指定callback参数时返回 Promise，并且使用 MV3+。 Promise 中的类型与callback的第一个参数相同。

get

chrome.management.get( id: string, callback?: function, )

Promise

返回有关具有给定 ID 的已安装扩展程序、应用程序或主题的信息。

PARAMETERS

id

​ string

来自 management.ExtensionInfo 项的 ID。

callback

​ function optional

回调参数如下所示：

(result: ExtensionInfo) => void

RETURNS

Promise<ExtensionInfo>

Pending

这仅在未指定callback参数时返回 Promise，并且使用 MV3+。 Promise 中的类型与callback的第一个参数相同。

getAll

chrome.management.getAll( callback?: function, )

Promise

返回有关已安装扩展程序和应用程序的信息列表。

PARAMETERS

callback

​ function optional

回调参数如下所示：

(result: ExtensionInfo[]) => void

RETURNS

Promise<ExtensionInfo[]>

Pending

这仅在未指定callback参数时返回 Promise，并且使用 MV3+。 Promise 中的类型与callback的第一个参数相同。

getPermissionWarningsById

chrome.management.getPermissionWarningsById( id: string, callback?: function, )

Promise

返回给定扩展 ID 的权限警告列表

PARAMETERS

id

​ string

已安装扩展的 ID。

callback

​ function optional

回调参数如下所示：

(permissionWarnings: string[]) => void

  • permissionWarnings

    ​ string[]

RETURNS

Promise<string[]>

Pending

这仅在未指定callback参数时返回 Promise，并且使用 MV3+。 Promise 中的类型与callback的第一个参数相同。

getPermissionWarningsByManifest

chrome.management.getPermissionWarningsByManifest( manifestStr: string, callback?: function, )

Promise

返回给定扩展清单字符串的权限警告列表。注意：无需请求清单中的“管理”权限即可使用此功能。

PARAMETERS

manifestStr

​ string

扩展清单 JSON 字符串。

callback

​ function optional

回调参数如下所示：

(permissionWarnings: string[]) => void

  • permissionWarnings

    ​ string[]

RETURNS

Promise<string[]>

Pending

这仅在未指定callback参数时返回 Promise，并且使用 MV3+。 Promise 中的类型与callback的第一个参数相同。

getSelf

chrome.management.getSelf(
  callback?: function,
)

Promise

返回有关调用扩展程序、应用程序或主题的信息。注意：无需请求清单中的“管理”权限即可使用此功能。

PARAMETERS

callback

​ function optional

回调参数如下所示：

(result: ExtensionInfo) => void

RETURNS

Promise<ExtensionInfo>

Pending

这仅在未指定callback参数时返回 Promise，并且使用 MV3+。 Promise 中的类型与callback的第一个参数相同。

installReplacementAndroidApp

chrome.management.installReplacementAndroidApp(
  callback?: function,
)

Promise In development

提示用户从清单安装替换的 Android 应用程序。此 API 产生的错误通过设置 runtime.lastError 并执行函数的常规回调来报告。

PARAMETERS

callback

​ function optional

回调参数如下所示：

() => void

RETURNS

Promise<void>

这仅在未指定callback参数时返回 Promise，并且使用 MV3+。 Promise 中的类型与callback的第一个参数相同。

installReplacementWebApp

chrome.management.installReplacementWebApp(
  callback?: function,
)

Promise Chrome 77+

启动清单中指定的 replacement_web_app。如果尚未安装，则提示用户进行安装。

PARAMETERS

callback

​ function optional

回调参数如下所示：

() => void

RETURNS

Promise<void>

Pending

这仅在未指定callback参数时返回 Promise，并且使用 MV3+。 Promise 中的类型与callback的第一个参数相同。

launchApp

chrome.management.launchApp(
  id: string,
  callback?: function,
)

Promise

启动应用程序。

PARAMETERS

id

​ string

应用程序的扩展 ID。

callback

​ function optional

回调参数如下所示：

() => void

RETURNS

Promise<void>

Pending

这仅在未指定callback参数时返回 Promise，并且使用 MV3+。 Promise 中的类型与callback的第一个参数相同。

setEnabled

chrome.management.setEnabled(
  id: string,
  enabled: boolean,
  callback?: function,
)

Promise

启用或禁用应用程序或扩展程序。在大多数情况下，必须在用户手势的上下文中调用此函数（例如按钮的 onclick 处理程序），并且可能会向用户显示本机确认 UI，以防止滥用。

PARAMETERS

id

​ string

这应该是来自 management.ExtensionInfo 项的 ID。

enabled

​ boolean

是否应启用或禁用此项目。

callback

​ function optional

回调参数如下所示：

() => void

RETURNS

Promise<void>

Pending

这仅在未指定callback参数时返回 Promise，并且使用 MV3+。 Promise 中的类型与callback的第一个参数相同。

setLaunchType

chrome.management.setLaunchType( id: string, launchType: LaunchType, callback?: function, )

Promise

设置应用程序的启动类型。

PARAMETERS

id

​ string

这应该是来自 management.ExtensionInfo 项的 ID。

launchType

​ LaunchType

目标启动类型。始终检查并确保此启动类型在 ExtensionInfo.availableLaunchTypes 中，因为可用的启动类型因平台和配置而异。

callback

​ function optional

回调参数如下所示：

() => void

RETURNS

Promise<void>

Pending

这仅在未指定callback参数时返回 Promise，并且使用 MV3+。 Promise 中的类型与callback的第一个参数相同。

uninstall

chrome.management.uninstall( id: string, options?: UninstallOptions, callback?: function, )

Promise

卸载当前安装的应用程序或扩展程序。注意：当不允许用户卸载指定的扩展程序/应用程序时，此功能在托管环境中不起作用。

PARAMETERS

id

​ string

这应该是来自 management.ExtensionInfo 项的 ID。

options

​ UninstallOptions optional

callback

​ function optional

回调参数如下所示：

() => void

RETURNS

Promise<void>

Pending

这仅在未指定callback参数时返回 Promise，并且使用 MV3+。 Promise 中的类型与callback的第一个参数相同。

uninstallSelf

chrome.management.uninstallSelf( options?: UninstallOptions, callback?: function, )

Promise

卸载呼叫扩展。注意：无需请求清单中的“管理”权限即可使用此功能。当不允许用户卸载指定的扩展程序/应用程序时，此功能在托管环境中不起作用。

PARAMETERS

options

​ UninstallOptions optional

callback

​ function optional

回调参数如下所示：

() => void

RETURNS

Promise<void>

Pending

这仅在未指定callback参数时返回 Promise，并且使用 MV3+。 Promise 中的类型与callback的第一个参数相同。

Events

onDisabled

chrome.management.onDisabled.addListener(
  callback: function,
)

当应用程序或扩展程序被禁用时触发。

PARAMETERS

callback

​ function

回调参数如下所示：

(info: ExtensionInfo) => void

onEnabled

chrome.management.onEnabled.addListener(
  callback: function,
)

在启用应用程序或扩展程序时触发。

PARAMETERS

callback

​ function

回调参数如下所示：

(info: ExtensionInfo) => void

onInstalled

chrome.management.onInstalled.addListener(
  callback: function,
)

在安装应用程序或扩展程序时触发。

PARAMETERS

callback

​ function

回调参数如下所示：

(info: ExtensionInfo) => void

onUninstalled

chrome.management.onUninstalled.addListener(
  callback: function,
)

卸载应用程序或扩展程序时触发。

PARAMETERS

callback

​ callback

回调参数如下所示：

(id: string) => void

  • id

    ​ string

By.一粒技术服务.

results matching ""

    No results matching ""