runtime.sendMessage()

extensionId Optional

string. Die ID der Erweiterung, an die die Nachricht gesendet werden soll. Geben Sie dies an, um die Nachricht an eine andere Erweiterung zu senden. Wenn der beabsichtigte Empfänger eine ID explizit mit dem browser_specific_settings-Schlüssel in der manifest.json festgelegt hat, sollte extensionId diesen Wert haben. Andernfalls sollte es die ID haben, die für den beabsichtigten Empfänger generiert wurde.

Wenn extensionId weggelassen wird, wird die Nachricht an Ihre Erweiterung gesendet.

message

any. Ein Objekt, das strukturiert kopierbar serialisiert werden kann (siehe Datenkopieralgorithmus).

options Optional

object.

includeTlsChannelId Optional

boolean. Ob die TLS-Kanal-ID in runtime.onMessageExternal für Prozesse, die auf das Verbindungsevent lauschen, übergeben wird.

Diese Option wird nur in Chromium-basierten Browsern unterstützt.

Abhängig von den übergebenen Argumenten ist diese API manchmal mehrdeutig. Die folgenden Regeln werden angewendet:

• Wenn ein Argument übergeben wird, ist es die zu sendende Nachricht, und die Nachricht wird intern gesendet.

• Wenn zwei Argumente übergeben werden:

  • Die Argumente werden als (message, options) interpretiert, und die Nachricht wird intern gesendet, wenn das zweite Argument eine der folgenden Optionen ist:

    1. ein gültiges options-Objekt (das bedeutet, es ist ein Objekt, das nur die vom Browser unterstützten Eigenschaften von options enthält)
    2. null
    3. undefined

  • andernfalls werden die Argumente als (extensionId, message) interpretiert. Die Nachricht wird an die durch extensionId identifizierte Erweiterung gesendet.

• Wenn drei Argumente übergeben werden, werden die Argumente als (extensionId, message, options) interpretiert. Die Nachricht wird an die durch extensionId identifizierte Erweiterung gesendet.

Beachten Sie, dass vor Firefox 55 die Regeln im Fall von zwei Argumenten anders waren. Nach den alten Regeln wurde, wenn das erste Argument ein String war, es als extensionId behandelt, und die Nachricht war das zweite Argument. Das bedeutete, wenn Sie sendMessage() mit Argumenten wie ("my-message", {}) aufriefen, dann würde es eine leere Nachricht an die durch "my-message" identifizierte Erweiterung senden. Nach den neuen Regeln würden Sie mit diesen Argumenten die Nachricht "my-message" intern senden, mit einem leeren options-Objekt.

Ein Promise. Wenn der Empfänger eine Antwort gesendet hat, wird dieses Promise mit der Antwort erfüllt. Andernfalls wird es ohne Argumente erfüllt. Wenn beim Verbindungsaufbau zur Erweiterung ein Fehler auftritt, wird das Promise mit einer Fehlermeldung abgelehnt.

Hier ist ein Inhalts-Skript, das eine Nachricht an das Hintergrundskript sendet, wenn der Benutzer auf das Inhaltsfenster klickt. Die Nachrichtennutzlast ist {greeting: "Greeting from the content script"}, und der Sender erwartet auch, eine Antwort zu erhalten, die in der Funktion handleResponse verarbeitet wird:

// content-script.js

function handleResponse(message) {
  console.log(`Message from the background script: ${message.response}`);
}

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

function notifyBackgroundPage(e) {
  const sending = browser.runtime.sendMessage({
    greeting: "Greeting from the content script",
  });
  sending.then(handleResponse, handleError);
}

window.addEventListener("click", notifyBackgroundPage);

Das entsprechende Hintergrundskript sieht so aus:

// background-script.js
function handleMessage(request, sender, sendResponse) {
  console.log(`A content script sent a message: ${request.greeting}`);
  sendResponse({ response: "Response from background script" });
}

browser.runtime.onMessage.addListener(handleMessage);

• content-script-register
• devtools-panels
• export-helpers
• find-across-tabs
• mocha-client-tests
• notify-link-clicks-i18n
• store-collected-images
• user-script-register
• userScripts-mv3
• webpack-modules