Modules

tabs.connect()

Cette traduction est incomplète. Aidez à traduire cet article depuis l'anglais.

Appelez cette fonction pour configurer une connexion entre les scripts d'arrière-plan de l'extension (ou d'autres scripts privilégiés, tels que les scripts d'arrière-plan de l'extrension (ou d'autres scripts privilégiés, tels que les scripts de pages d'options) et les scripts de contenu appartenant à cette extension et s'exécutant dans l'onglet spécifié. Cette fonction renvoie un objet runtime.Port.

Lorsque cela est appelée, l'événement runtime.onConnect est déclenché dans tout script de contenu appartenant à cette extension qui s'exécute dans l'onglet spécifié. L'écouteur d'événement recevra un autre objet  runtime.Port. Les deux parties peuvent ensuite utiliser les objets Port pour échanger des messages.

Pour plus de détails, voir connection-based messaging.

Syntax

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

Parameters

tabId
integer. ID of the tab whose content scripts we want to connect to.
connectInfoFacultatif
object.
nameFacultatif
string. Will be passed into runtime.onConnect event listeners in content scripts belonging to this extension and running in the specified tab.
frameIdFacultatif
integer. Open a port to a specific frame identified by frameId instead of all frames in the tab.

Return value

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

Browser compatibility

ChromeEdgeFirefoxFirefox for AndroidOpera
Support simple Oui Non4554 Oui

Examples

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);
});

Acknowledgements

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.

Étiquettes et contributeurs liés au document

 Contributeurs à cette page : hellosct1
 Dernière mise à jour par : hellosct1,