runtime.onMessageExternal

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 listener argument is the listener to remove.

hasListener(listener)

Checks whether a listener is registered for this event. Returns true if it is listening, false otherwise.

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 onMessageExternal listener 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 return true from the listener function. You then call sendResponse() after the listener function returns.

  Note: Promise as a return value is not supported in Chrome until Chrome bug 1185241 is resolved. As an alternative, return true and use sendResponse as described for runtime.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