extension
Utilities related to your extension. Get URLs to resources packages with your extension. Get the Window object for your extension's pages. Get the values for various settings.
Note:
The messaging APIs in this module are deprecated in favor of the equivalent APIs in the runtime module.
Types
extension.ViewType-
The type of extension view.
Properties
extension.lastError-
Set for the lifetime of a callback if an asynchronous extension API has resulted in an error. If no error has occurred,
lastErrorwill beundefined. extension.inIncognitoContext-
Truefor content scripts running inside incognito tabs, and for extension pages running inside an incognito process. (The latter only applies to extensions with"incognito": "split"set in their manifest.json file.)
Functions
extension.getBackgroundPage()-
Returns the
Windowobject for the background page running inside the current extension. Returnsnullif the extension has no background page. extension.getExtensionTabs()-
Returns an array of the JavaScript Window objects for each of the tabs running inside the current extension.
extension.getURL()-
Converts a relative path within an extension install directory to a fully-qualified URL.
extension.getViews()-
Returns an array of the
Windowobjects for each of the pages running inside the current extension. extension.isAllowedIncognitoAccess()-
Retrieves the state of the extension's access to Incognito-mode (as determined by the user-controlled 'Allowed in Incognito' checkbox).
extension.isAllowedFileSchemeAccess()-
Retrieves the state of the extension's access to the
file://scheme (as determined by the user-controlled 'Allow access to File URLs' checkbox). extension.sendRequest()-
Sends a single request to other listeners within the extension.
extension.setUpdateUrlData()-
Sets the value of the ap CGI parameter used in the extension's update URL. This value is ignored for extensions that are hosted in the browser vendor's store.
Events
extension.onRequest-
Fired when a request is sent from either an extension process or a content script.
extension.onRequestExternal-
Fired when a request is sent from another extension.
Example extensions
Browser compatibility
| desktop | mobile | ||||||
|---|---|---|---|---|---|---|---|
extension
|
|
|
|
|
|
|
|
ViewType
|
|
|
|
|
|
|
|
ViewType.sidebar
|
|
|
|
|
|
|
|
getBackgroundPage
|
|
|
|
|
|
|
|
getExtensionTabs
|
|
|
|
|
|
|
|
getURL
|
|
|
|
|
|
|
|
getViews
|
|
|
|
|
|
|
|
getViews.windowId
|
|
|
|
|
|
|
|
inIncognitoContext
|
|
|
|
|
|
|
|
isAllowedFileSchemeAccess
|
|
|
|
|
|
|
|
isAllowedIncognitoAccess
|
|
|
|
|
|
|
|
lastError
|
|
|
|
|
|
|
|
onRequest
|
|
|
|
|
|
|
|
onRequestExternal
|
|
|
|
|
|
|
|
sendRequest
|
|
|
|
|
|
|
|
setUpdateUrlData
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- Partial support
- Partial support
- No support
- No support
- See implementation notes.
- Uses a non-standard name
- Has more compatibility info.
Note:
This API is based on Chromium's chrome.extension API. This documentation is derived from extension.json in the Chromium code.