extension.onRequest
Warning: This is not implemented in Firefox because it has been deprecated since Chrome 33. Please use runtime.onMessage instead.
Fired when a request is sent from either an extension process or a content script.
Syntax
chrome.extension.onRequest.addListener(function( request, // optional any sender, // runtime.MessageSender function() {...} // function ) {...}) chrome.extension.onRequest.removeListener(listener) chrome.extension.onRequest.hasListener(listener)
Events have three functions:
addListener(callback)
- Adds a listener to this event.
removeListener(listener)
- Stop listening to this event. The
listener
argument is the listener to remove. hasListener(listener)
- Check whether
listener
is registered for this event. Returnstrue
if it is listening,false
otherwise.
addListener syntax
Parameters
callback
-
Function that will be called when this event occurs. The function will be passed the following arguments:
request
-
any
. The request sent by the calling script.
sender
-
runtime.MessageSender
.
sendResponse
-
function
. Function to call (at most once) when you have a response. The argument should be any JSON-ifiable object, or undefined if there is no response. If you have more than oneonRequest
listener in the same document, then only one may send a response.
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
onRequest |
Yes |
79 |
No |
? |
Yes |
No |
? |
? |
No |
? |
? |
? |
Note: 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.
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/extension/onRequest