Not implemented: 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.
SyntaxEdit
browser.extension.onRequest.addListener(function(
request, // optional any
sender, // runtime.MessageSender
function() {...} // function
) {...})
browser.extension.onRequest.removeListener(listener)
browser.extension.onRequest.hasListener(listener)Events have three functions:
addListener(callback)- Adds a listener to this event.
removeListener(listener)- Stop listening to this event. The
listenerargument is the listener to remove. hasListener(listener)- Check whether
listeneris registered for this event. Returnstrueif it is listening,falseotherwise.
addListener syntaxEdit
Parameters
callback-
Function that will be called when this event occurs. The function will be passed the following arguments:
requestany. The request sent by the calling script.
senderruntime.MessageSender.
sendResponsefunction. 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 oneonRequestlistener in the same document, then only one may send a response.
Browser compatibilityEdit
Acknowledgements
This API is based on Chromium's chrome.extension API. This documentation is derived from extension.json in the Chromium code.
// 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.Document Tags and Contributors
Tags:
Contributors to this page:
wbamberg,
andymckay-github
Last updated by:
wbamberg,
