tabs.connect()

Call this function to set up a connection between the extension's background scripts (or other privileged scripts, such as popup scripts or options page scripts) and any content scripts that belong to this extension and are running in the specified tab. This function returns a runtime.Port 对象。

When this is called, the runtime.onConnect event will be fired in any content script belonging to this extension that are running in the specified tab. The event listener will be passed another runtime.Port object. The two sides can then use the Port objects to exchange messages.

更多细节,见 connection-based messaging . You can message without creating a connection, for advice on choosing between the options, see Choosing between one-off messages and connection-based messaging .

句法

browser.tabs.connect(
  tabId,      // integer
  connectInfo // optional object
)

					

参数

tabId

integer . ID of the tab whose content scripts we want to connect to.

connectInfo 可选

An object with the following properties:

名称 可选

string . Will be passed into runtime.onConnect event listeners in content scripts belonging to this extension and running in the specified tab.

frameId 可选

integer . Open a port to a specific frame identified by frameId instead of all frames in the tab.

返回值

runtime.Port . A port that can be used to communicate with the content scripts running in the specified tab.

范例

In this example a background script listens for a click on a browser action , then connects to the currently active tab, then sends a message using the Port that's returned from connect() :

function connectToTab(tabs) {
  if (tabs.length > 0) {
    var examplePort = browser.tabs.connect(
      tabs[0].id,
      {name: "tabs-connect-example"}
    );
    examplePort.postMessage({greeting: "Hi from background script"});
  }
}
function onError(error) {
  console.log(`Error: ${error}`);
}
browser.browserAction.onClicked.addListener(function() {
  var gettingActive = browser.tabs.query({
    currentWindow: true, active: true
  });
  gettingActive.then(connectToTab, onError);
});

						

浏览器兼容性

BCD tables only load in the browser

注意: This API is based on Chromium's chrome.tabs API. This documentation is derived from tabs.json in the Chromium code.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

Found a problem with this page?

最后修改: , 由 MDN 贡献者

  1. 浏览器扩展名
  2. 快速入门
    1. What are extensions?
    2. Your first extension
    3. Your second extension
    4. Anatomy of an extension
    5. Example extensions
    6. What next?
  3. 概念
    1. Using the JavaScript APIs
    2. Content scripts
    3. Match patterns
    4. Working with files
    5. 国际化
    6. Content Security Policy
    7. Native messaging
    8. Differences between API implementations
    9. Chrome incompatibilities
  4. 用户界面
    1. 用户界面
    2. Toolbar button
    3. Address bar button
    4. Sidebars
    5. Context menu items
    6. Options page
    7. Extension pages
    8. Notifications
    9. Address bar suggestions
    10. Developer tools panels
  5. 如何
    1. Intercept HTTP requests
    2. Modify a web page
    3. Insert external content
    4. Share objects with page scripts
    5. Add a button to the toolbar
    6. Implement a settings page
    7. Work with the Tabs API
    8. Work with the Bookmarks API
    9. Work with the Cookies API
    10. Work with contextual identities
    11. Interact with the clipboard
    12. Build a cross-browser extension
  6. Firefox differentiators
  7. JavaScript API
    1. Browser support for JavaScript APIs
    2. alarms
    3. bookmarks
    4. browserAction
    5. browserSettings
    6. browsingData
    7. captivePortal
    8. clipboard
    9. 命令
    10. contentScripts
    11. contextualIdentities
    12. Cookie
    13. devtools
    14. dns
    15. downloads
    16. events
    17. extension
    18. extensionTypes
    19. find
    20. history
    21. i18n
    22. identity
    23. idle
    24. management
    25. menus
    26. notifications
    27. omnibox
    28. pageAction
    29. permissions
    30. pkcs11
    31. privacy
    32. proxy
    33. runtime
    34. search
    35. sessions
    36. sidebarAction
    37. storage
    38. tabs
      1. 方法
        1. captureTab()
        2. captureVisibleTab()
        3. connect()
        4. create()
        5. detectLanguage()
        6. discard()
        7. duplicate()
        8. executeScript()
        9. get()
        10. getAllInWindow()
        11. getCurrent()
        12. getSelected()
        13. getZoom()
        14. getZoomSettings()
        15. goBack()
        16. goForward()
        17. hide()
        18. highlight()
        19. insertCSS()
        20. move()
        21. moveInSuccession()
        22. print()
        23. printPreview()
        24. query()
        25. reload()
        26. remove()
        27. removeCSS()
        28. saveAsPDF()
        29. sendMessage()
        30. sendRequest()
        31. setZoom()
        32. setZoomSettings()
        33. show()
        34. toggleReaderMode()
        35. update()
        36. warmup()
      2. 特性
        1. TAB_ID_NONE
      3. 类型
        1. MutedInfo
        2. MutedInfoReason
        3. PageSettings
        4. Tab
        5. TabStatus
        6. WindowType
        7. ZoomSettings
        8. ZoomSettingsMode
        9. ZoomSettingsScope
      4. 事件
        1. onActivated
        2. onActiveChanged
        3. onAttached
        4. onCreated
        5. onDetached
        6. onHighlightChanged
        7. onHighlighted
        8. onMoved
        9. onRemoved
        10. onReplaced
        11. onSelectionChanged
        12. onUpdated
        13. onZoomChange
    39. theme
    40. topSites
    41. 类型
    42. userScripts
    43. webNavigation
    44. webRequest
    45. windows
  8. Manifest keys
    1. 介绍
    1. 作者
    2. background
    3. browser_action
    4. browser_specific_settings
    5. chrome_settings_overrides
    6. chrome_url_overrides
    7. 命令
    8. content_scripts
    9. content_security_policy
    10. default_locale
    11. description
    12. developer
    13. devtools_page
    14. dictionaries
    15. externally_connectable
    16. homepage_url
    17. icons
    18. incognito
    19. manifest_version
    20. name
    21. offline_enabled
    22. omnibox
    23. optional_permissions
    24. options_page
    25. options_ui
    26. page_action
    27. permissions
    28. protocol_handlers
    29. short_name
    30. sidebar_action
    31. storage
    32. theme
    33. theme_experiment
    34. user_scripts
    35. version
    36. version_name
    37. web_accessible_resources
  9. Extension Workshop
    1. Develop
    2. Publish
    3. Manage
    4. Enterprise
  10. Contact us
  11. Channels
    1. Add-ons blog
    2. Add-ons forum
    3. Add-ons chat