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 ansychronous extension API has resulted in an error. If no error has, occured
lastError
will beundefined
. extension.inIncognitoContext
True
for content scripts running inside incognito tabs, and for extension pages running inside an incognito process. (The latter only applies to extensions with 'split
'incognito_behavior
.)
Functions
extension.getBackgroundPage()
- Returns the
Window
object for the background page running inside the current extension. Returnsnull
if 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
Window
objects 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.
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Desktop | Mobile | |||||
---|---|---|---|---|---|---|
ViewType | Chrome Full support Yes | Edge Full support 79 | Firefox Full support 45 | Opera Full support Yes | Safari Full support 14 | Firefox Android Full support 48 |
getBackgroundPage | Chrome Full support Yes | Edge Full support 14 | Firefox Full support 45 | Opera Full support Yes | Safari Full support 14 | Firefox Android Full support 48 |
getExtensionTabs | Chrome Full support Yes | Edge Full support 79 | Firefox No support No | Opera No support No | Safari No support No | Firefox Android No support No |
getURL | Chrome Full support Yes | Edge Full support 14 | Firefox Full support 45 | Opera Full support Yes | Safari Full support 14 | Firefox Android Full support 48 |
getViews | Chrome Full support Yes | Edge Full support 14 | Firefox
Full support
45
| Opera Full support Yes | Safari Full support 14 | Firefox Android
Full support
48
|
inIncognitoContext | Chrome Full support Yes | Edge Full support 17 | Firefox Full support 45 | Opera Full support Yes | Safari
Partial support
14
| Firefox Android Full support 48 |
isAllowedFileSchemeAccess | Chrome Full support Yes | Edge Full support 79 | Firefox Full support 48 | Opera Full support Yes | Safari
Partial support
14
| Firefox Android Full support 48 |
isAllowedIncognitoAccess | Chrome Full support Yes | Edge Full support 17 | Firefox Full support 48 | Opera Full support Yes | Safari
Partial support
14
| Firefox Android Full support 48 |
lastError | Chrome Full support Yes | Edge Full support 79 | Firefox Full support 47 | Opera Full support Yes | Safari No support No | Firefox Android Full support 48 |
onRequest | Chrome Full support Yes | Edge Full support 79 | Firefox No support No | Opera Full support Yes | Safari No support No | Firefox Android No support No |
onRequestExternal | Chrome Full support Yes | Edge Full support 79 | Firefox No support No | Opera Full support Yes | Safari No support No | Firefox Android No support No |
sendRequest | Chrome Full support Yes | Edge Full support 79 | Firefox No support No | Opera No support No | Safari No support No | Firefox Android No support No |
setUpdateUrlData | Chrome Full support Yes | Edge Full support 79 | Firefox No support No | Opera Full support Yes | Safari No support No | Firefox Android No support No |
Legend
- Full support
- Full support
- Partial support
- Partial support
- No support
- No support
- Non-standard. Expect poor cross-browser support.
- Non-standard. Expect poor cross-browser support.
- Deprecated. Not for use in new websites.
- Deprecated. Not for use in new websites.
- See implementation notes.
- See implementation notes.
Example extensions
- beastify
- cookie-bg-picker
- find-across-tabs
- imagify
- notify-link-clicks-i18n
- proxy-blocker
- user-agent-rewriter
Acknowledgements
This API is based on Chromium's chrome.extension
API. This documentation is derived from extension.json
in the Chromium code.
Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.
// Copyright 2015 The Chromium Authors. All rights reserved. // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions are // met: // // * Redistributions of source code must retain the above copyright // notice, this list of conditions and the following disclaimer. // * Redistributions in binary form must reproduce the above // copyright notice, this list of conditions and the following disclaimer // in the documentation and/or other materials provided with the // distribution. // * Neither the name of Google Inc. nor the names of its // contributors may be used to endorse or promote products derived from // this software without specific prior written permission. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.