tabs.sendMessage()

Sendet eine einzelne Nachricht von den Hintergrundskripten der Erweiterung (oder anderen privilegierten Skripten, wie z.B. Popup-Skripte oder Optionsseitenskripte) an alle Content-Skripte oder Erweiterungsseiten/IFrames, die zur Erweiterung gehören und im angegebenen Tab ausgeführt werden.

Die Nachricht wird im Erweiterungskontext von jedem Listener des runtime.onMessage-Ereignisses empfangen. Listener können dann optional etwas als Antwort an den Absender zurücksenden.

Dies ist eine asynchrone Funktion, die ein Promise zurückgibt.

Hinweis: Sie können auch einen verbindungsbasierten Ansatz zum Nachrichtenaustausch verwenden.

Syntax

js
const sending = browser.tabs.sendMessage(
  tabId,     // integer
  message,   // any
  options    // optional object
)

Parameter

tabId

integer. ID des Tabs, dessen Content-Skripten wir eine Nachricht senden wollen.

message

any. Ein Objekt, das serialisierbar ist (siehe Datenklon-Algorithmus).

options Optional

object.

frameId Optional

integer. Sendet die Nachricht an einen spezifischen Frame, identifiziert durch frameId, anstatt an alle Frames im Tab. Ob das Content-Skript in allen Frames ausgeführt wird, hängt von der all_frames-Einstellung im content_scripts-Abschnitt der manifest.json ab.

Rückgabewert

Ein Promise, das mit dem Antwortobjekt erfüllt wird, das vom Nachrichten-Handler im Content-Skript gesendet wird, oder ohne Argumente, falls das Content-Skript keine Antwort gesendet hat.

Wenn ein Fehler beim Verbinden mit dem angegebenen Tab oder ein anderer Fehler auftritt, wird das Promise mit einer Fehlermeldung abgelehnt.

Wenn mehrere Frames auf die Nachricht antworten, wird das Promise mit einer der Antworten aufgelöst.

Beispiele

Hier ist ein Beispiel für ein Hintergrundskript, das eine Nachricht an die Content-Skripte sendet, die im aktiven Tab laufen, wenn der Benutzer die Browser-Aktion anklickt. Das Hintergrundskript erwartet auch, dass das Content-Skript eine Antwort sendet:

js
// background-script.js
"use strict";

function onError(error) {
  console.error(`Error: ${error}`);
}

function sendMessageToTabs(tabs) {
  for (const tab of tabs) {
    browser.tabs
      .sendMessage(tab.id, { greeting: "Hi from background script" })
      .then((response) => {
        console.log("Message from the content script:");
        console.log(response.response);
      })
      .catch(onError);
  }
}

browser.browserAction.onClicked.addListener(() => {
  browser.tabs
    .query({
      currentWindow: true,
      active: true,
    })
    .then(sendMessageToTabs)
    .catch(onError);
});

Hier ist das entsprechende Content-Skript:

js
// content-script.js
"use strict";

browser.runtime.onMessage.addListener((request) => {
  console.log("Message from the background script:");
  console.log(request.greeting);
  return Promise.resolve({ response: "Hi from content script" });
});

Beispielerweiterungen

Browser-Kompatibilität

BCD tables only load in the browser

Hinweis: Diese API basiert auf der chrome.tabs-API von Chromium. Diese Dokumentation ist abgeleitet von tabs.json im Chromium-Code.