Sends a single message to event listeners within your extension or a different extension.
This is like runtime.connect but only sends a single message, with an optional response.
If sending to your extension, the runtime.onMessage event will be fired in each page. If sending to a different extension, runtime.onMessageExternal will be fired.
Note that extensions cannot send messages to content scripts using this method. To send messages to content scripts, use tabs.sendMessage.
Syntax
browser.runtime.sendMessage(
extensionId, // optional string
message, // any
options, // optional object
function(response) {...} // optional function
)
Parameters
extensionIdOptionalstring. The ID of the extension to send the message to. If omitted, the message will be sent to your own extension.messageany.optionsOptionalobject.includeTlsChannelIdOptionalboolean. Whether the TLS channel ID will be passed into onMessageExternal for processes that are listening for the connection event.
responseCallbackOptionalfunction. The function is passed the following arguments:responseany. The JSON response object sent by the handler of the message. If an error occurs while connecting to the extension, the callback will be called with no arguments andruntime.lastErrorwill be set to the error message.
Browser compatibility
Examples
Example add-ons
Acknowledgements
This API is based on Chromium's chrome.runtime API. This documentation is derived from runtime.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.
