chrome.management
Description: |
The chrome.management API provides ways to manage the list of extensions/apps that are installed and running. It is particularly useful for extensions that override the built-in New Tab page.
|
Availability: |
Since Chrome 35.
|
Permissions: |
"management"
|
Manifest
You must declare the "management" permission in the extension manifest to use the management API. For example:
{ "name": "My extension", ... "permissions": [ "management" ], ... }
management.getPermissionWarningsByManifest, management.uninstallSelf, and management.getSelf do not require the management permission.
Summary
Types | |
---|---|
IconInfo | |
LaunchType | |
ExtensionDisabledReason | |
ExtensionType | |
ExtensionInstallType | |
ExtensionInfo | |
Methods | |
getAll −
chrome.management.getAll(function callback)
| |
get −
chrome.management.get(string id, function callback)
| |
getSelf −
chrome.management.getSelf(function callback)
| |
getPermissionWarningsById −
chrome.management.getPermissionWarningsById(string id, function callback)
| |
getPermissionWarningsByManifest −
chrome.management.getPermissionWarningsByManifest(string manifestStr, function callback)
| |
setEnabled −
chrome.management.setEnabled(string id, boolean enabled, function callback)
| |
uninstall −
chrome.management.uninstall(string id, object options, function callback)
| |
uninstallSelf −
chrome.management.uninstallSelf(object options, function callback)
| |
launchApp −
chrome.management.launchApp(string id, function callback)
| |
createAppShortcut −
chrome.management.createAppShortcut(string id, function callback)
| |
setLaunchType −
chrome.management.setLaunchType(string id, LaunchType launchType, function callback)
| |
generateAppForLink −
chrome.management.generateAppForLink(string url, string title, function callback)
| |
canInstallReplacementAndroidApp −
chrome.management.canInstallReplacementAndroidApp(function callback)
| |
installReplacementAndroidApp −
chrome.management.installReplacementAndroidApp(function callback)
| |
installReplacementWebApp −
chrome.management.installReplacementWebApp(function callback)
| |
Events | |
onInstalled | |
onUninstalled | |
onEnabled | |
onDisabled |
Types
IconInfo
properties | ||
---|---|---|
integer | size |
A number representing the width and height of the icon. Likely values include (but are not limited to) 128, 48, 24, and 16. |
string | url |
The URL for this icon image. To display a grayscale version of the icon (to indicate that an extension is disabled, for example), append |
LaunchType
Enum |
---|
"OPEN_AS_REGULAR_TAB" ,
"OPEN_AS_PINNED_TAB" ,
"OPEN_AS_WINDOW" ,
or "OPEN_FULL_SCREEN"
|
ExtensionDisabledReason
Enum |
---|
"unknown" ,
or "permissions_increase"
|
ExtensionType
Enum |
---|
"extension" ,
"hosted_app" ,
"packaged_app" ,
"legacy_packaged_app" ,
"theme" ,
or "login_screen_extension"
|
ExtensionInstallType
Enum |
---|
"admin" ,
"development" ,
"normal" ,
"sideload" ,
or "other"
|
ExtensionInfo
properties | ||
---|---|---|
string | id |
The extension's unique identifier. |
string | name |
The name of this extension, app, or theme. |
string | shortName |
A short version of the name of this extension, app, or theme. |
string | description |
The description of this extension, app, or theme. |
string | version |
The version of this extension, app, or theme. |
string | (optional) versionName |
Since Chrome 50. The version name of this extension, app, or theme if the manifest specified one. |
boolean | mayDisable |
Whether this extension can be disabled or uninstalled by the user. |
boolean | (optional) mayEnable |
Since Chrome 62. Whether this extension can be enabled by the user. This is only returned for extensions which are not enabled. |
boolean | enabled |
Whether it is currently enabled or disabled. |
ExtensionDisabledReason | (optional) disabledReason |
A reason the item is disabled. |
boolean | isApp |
Deprecated since Chrome 35. Please use management.ExtensionInfo.type. True if this is an app. |
ExtensionType | type |
The type of this extension, app, or theme. |
string | (optional) appLaunchUrl |
The launch url (only present for apps). |
string | (optional) homepageUrl |
The URL of the homepage of this extension, app, or theme. |
string | (optional) updateUrl |
The update URL of this extension, app, or theme. |
boolean | offlineEnabled |
Whether the extension, app, or theme declares that it supports offline. |
string | optionsUrl |
The url for the item's options page, if it has one. |
array of IconInfo | (optional) icons |
A list of icon information. Note that this just reflects what was declared in the manifest, and the actual image at that url may be larger or smaller than what was declared, so you might consider using explicit width and height attributes on img tags referencing these images. See the manifest documentation on icons for more details. |
array of string | permissions |
Returns a list of API based permissions. |
array of string | hostPermissions |
Returns a list of host based permissions. |
ExtensionInstallType | installType |
How the extension was installed. |
LaunchType | (optional) launchType |
Since Chrome 37. The app launch type (only present for apps). |
array of LaunchType | (optional) availableLaunchTypes |
Since Chrome 37. The currently available launch types (only present for apps). |
Methods
getAll
chrome.management.getAll(function callback)
Returns a list of information about installed extensions and apps.
Parameters | |||||
---|---|---|---|---|---|
function | (optional) callback |
If you specify the callback parameter, it should be a function that looks like this: function(array of ExtensionInfo result) {...};
|
get
chrome.management.get(string id, function callback)
Returns information about the installed extension, app, or theme that has the given ID.
Parameters | |||||
---|---|---|---|---|---|
string | id |
The ID from an item of management.ExtensionInfo. |
|||
function | (optional) callback |
If you specify the callback parameter, it should be a function that looks like this: function( ExtensionInfo result) {...};
|
getSelf
chrome.management.getSelf(function callback)
Since Chrome 39.
Returns information about the calling extension, app, or theme. Note: This function can be used without requesting the 'management' permission in the manifest.
Parameters | |||||
---|---|---|---|---|---|
function | (optional) callback |
If you specify the callback parameter, it should be a function that looks like this: function( ExtensionInfo result) {...};
|
getPermissionWarningsById
chrome.management.getPermissionWarningsById(string id, function callback)
Returns a list of permission warnings for the given extension id.
Parameters | |||||
---|---|---|---|---|---|
string | id |
The ID of an already installed extension. |
|||
function | (optional) callback |
If you specify the callback parameter, it should be a function that looks like this: function(array of string permissionWarnings) {...};
|
getPermissionWarningsByManifest
chrome.management.getPermissionWarningsByManifest(string manifestStr, function callback)
Returns a list of permission warnings for the given extension manifest string. Note: This function can be used without requesting the 'management' permission in the manifest.
Parameters | |||||
---|---|---|---|---|---|
string | manifestStr |
Extension manifest JSON string. |
|||
function | (optional) callback |
If you specify the callback parameter, it should be a function that looks like this: function(array of string permissionWarnings) {...};
|
setEnabled
chrome.management.setEnabled(string id, boolean enabled, function callback)
Enables or disables an app or extension. In most cases this function must be called in the context of a user gesture (e.g. an onclick handler for a button), and may present the user with a native confirmation UI as a way of preventing abuse.
Parameters | ||
---|---|---|
string | id |
This should be the id from an item of management.ExtensionInfo. |
boolean | enabled |
Whether this item should be enabled or disabled. |
function | (optional) callback |
If you specify the callback parameter, it should be a function that looks like this: function() {...};
|
uninstall
chrome.management.uninstall(string id, object options, function callback)
Uninstalls a currently installed app or extension.
Parameters | |||||
---|---|---|---|---|---|
string | id |
This should be the id from an item of management.ExtensionInfo. |
|||
object | (optional) options |
|
|||
function | (optional) callback |
If you specify the callback parameter, it should be a function that looks like this: function() {...};
|
uninstallSelf
chrome.management.uninstallSelf(object options, function callback)
Uninstalls the calling extension. Note: This function can be used without requesting the 'management' permission in the manifest.
Parameters | |||||
---|---|---|---|---|---|
object | (optional) options |
|
|||
function | (optional) callback |
If you specify the callback parameter, it should be a function that looks like this: function() {...};
|
launchApp
chrome.management.launchApp(string id, function callback)
Launches an application.
Parameters | ||
---|---|---|
string | id |
The extension id of the application. |
function | (optional) callback |
If you specify the callback parameter, it should be a function that looks like this: function() {...};
|
createAppShortcut
chrome.management.createAppShortcut(string id, function callback)
Since Chrome 37.
Display options to create shortcuts for an app. On Mac, only packaged app shortcuts can be created.
Parameters | ||
---|---|---|
string | id |
Since Chrome 36. This should be the id from an app item of management.ExtensionInfo. |
function | (optional) callback |
If you specify the callback parameter, it should be a function that looks like this: function() {...};
|
setLaunchType
chrome.management.setLaunchType(string id, LaunchType launchType, function callback)
Since Chrome 37.
Set the launch type of an app.
Parameters | ||
---|---|---|
string | id |
This should be the id from an app item of management.ExtensionInfo. |
LaunchType | launchType |
The target launch type. Always check and make sure this launch type is in ExtensionInfo.availableLaunchTypes, because the available launch types vary on different platforms and configurations. |
function | (optional) callback |
If you specify the callback parameter, it should be a function that looks like this: function() {...};
|
generateAppForLink
chrome.management.generateAppForLink(string url, string title, function callback)
Since Chrome 37.
Generate an app for a URL. Returns the generated bookmark app.
Parameters | |||||
---|---|---|---|---|---|
string | url |
The URL of a web page. The scheme of the URL can only be "http" or "https". |
|||
string | title |
The title of the generated app. |
|||
function | (optional) callback |
If you specify the callback parameter, it should be a function that looks like this: function( ExtensionInfo result) {...};
|
canInstallReplacementAndroidApp
chrome.management.canInstallReplacementAndroidApp(function callback)
Since Chrome 78.
Checks if the replacement android app can be installed. Errors generated by this API are reported by setting runtime.lastError and executing the function's regular callback.
Parameters | |||||
---|---|---|---|---|---|
function | callback |
The callback parameter should be a function that looks like this: function(boolean result) {...};
|
installReplacementAndroidApp
chrome.management.installReplacementAndroidApp(function callback)
Since Chrome 78.
Prompts the user to install the replacement Android app from the manifest. Errors generated by this API are reported by setting runtime.lastError and executing the function's regular callback.
Parameters | ||
---|---|---|
function | (optional) callback |
If you specify the callback parameter, it should be a function that looks like this: function() {...};
|
installReplacementWebApp
chrome.management.installReplacementWebApp(function callback)
Since Chrome 75.
Launches the replacement_web_app specified in the manifest. Prompts the user to install if not already installed.
Parameters | ||
---|---|---|
function | (optional) callback |
If you specify the callback parameter, it should be a function that looks like this: function() {...};
|
Events
onInstalled
Fired when an app or extension has been installed.
addListener
chrome.management.onInstalled.addListener(function callback)
Parameters | |||||
---|---|---|---|---|---|
function | callback |
The callback parameter should be a function that looks like this: function( ExtensionInfo info) {...};
|
onUninstalled
Fired when an app or extension has been uninstalled.
addListener
chrome.management.onUninstalled.addListener(function callback)
Parameters | |||||
---|---|---|---|---|---|
function | callback |
The callback parameter should be a function that looks like this: function(string id) {...};
|
onEnabled
Fired when an app or extension has been enabled.
addListener
chrome.management.onEnabled.addListener(function callback)
Parameters | |||||
---|---|---|---|---|---|
function | callback |
The callback parameter should be a function that looks like this: function( ExtensionInfo info) {...};
|
onDisabled
Fired when an app or extension has been disabled.
addListener
chrome.management.onDisabled.addListener(function callback)
Parameters | |||||
---|---|---|---|---|---|
function | callback |
The callback parameter should be a function that looks like this: function( ExtensionInfo info) {...};
|