runtime.onMessageExternal
Use this event to listen for messages from other extensions or web pages.
Use this event to listen for messages from other extensions or web pages.
By default, an extension can receive messages from any other extension. However, the externally_connectable manifest key can be used to limit communication to specific extensions and enable communication with websites.
To send a message that is received by the onMessageExternal listener, use runtime.sendMessage(), passing the ID of the recipient in the extensionId parameter.
Along with the message, the listener is passed:
- a
senderobject with details about the message sender. - a
sendResponsefunction that the listener can use to send a response back to the sender.
This API can't be used in a content script.
See runtime.onMessage for additional information on receiving messages and sending responses, as well as examples of the various options for sending responses.
Syntax
browser.runtime.onMessageExternal.addListener()
browser.runtime.onMessageExternal.removeListener(listener)
browser.runtime.onMessageExternal.hasListener(listener)
Events have three functions:
addListener(listener)- : Adds a listener to this event.
removeListener(listener)- : Stop listening to this event. The
listenerargument is the listener to remove. hasListener(listener)- : Checks whether a
listeneris registered for this event. Returnstrueif it is listening,falseotherwise.
addListener syntax
Parameters
listener- : The function called when this event occurs. The function is passed these arguments:
message- :
object. The message. This is a JSON-ifiable object. sender- : A runtime.MessageSender object representing the sender of the message.
sendResponse-
: A function to call, at most once, to send a response to the message. The function takes one argument, which is a JSON-ifiable object. This argument is passed back to the message sender.
If you have more than one
onMessageExternallistener in the same document, then only one can send a response.To send a response synchronously, call
sendResponse()before the listener function returns.To send a response asynchronously, use one of these options: - Return a Promise from the listener function and resolve the promise when the response is ready. This is the preferred approach. - Keep a reference to the
sendResponse()argument and returntruefrom the listener function. You then callsendResponse()after the listener function returns.[!NOTE] Chrome supports Promise as a return value starting with Chrome 148, or Chrome 152 for extensions that include a DevTools page. For earlier versions of Chrome, return
trueand usesendResponseas described forruntime.onMessage.
Examples
In this example, the extension "blue\@mozilla.org" sends a message to the extension "red\@mozilla.org":
// sender: browser.runtime.id === "blue@mozilla.org"
// Send a message to the extension whose ID is "red@mozilla.org"
browser.runtime.sendMessage("red@mozilla.org", "my message");
// recipient: browser.runtime.id === "red@mozilla.org"
function handleMessage(message, sender) {
// check that the message is from "blue@mozilla.org"
if (sender.id === "blue@mozilla.org") {
// process message
}
}
browser.runtime.onMessageExternal.addListener(handleMessage);
Browser compatibility
[!NOTE] This API is based on Chromium's
chrome.runtimeAPI. This documentation is derived fromruntime.jsonin the Chromium code.