Attempts to connect listeners within an extension (such as the background page), or other extensions. This is useful for content scripts connecting to their extension processes and extension communication.
Note that this does not connect to any listeners in a content script. Extensions may connect to content scripts embedded in tabs via tabs.connect.
Syntax
browser.runtime.connect( extensionId, // optional string connectInfo // optional object )
Parameters
extensionIdOptionalstring. The ID of the extension to connect to. If omitted, a connection will be attempted with your own extension.connectInfoOptionalobject.-
nameOptionalstring. Will be passed intoruntime.onConnectfor processes that are listening for the connection event.includeTlsChannelIdOptionalboolean. Whether the TLS channel ID will be passed intoruntime.onConnectExternalfor processes that are listening for the connection event.
Return value
runtime.Port. Port through which messages can be sent and received. The port's onDisconnect event is fired if the extension does not exist.
Browser compatibility
Examples
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.
