runtime.onMessageExternal
Verwenden Sie dieses Ereignis, um auf Nachrichten von anderen Erweiterungen oder Webseiten zu warten.
Standardmäßig kann eine Erweiterung Nachrichten von jeder anderen Erweiterung empfangen. Mit dem Manifest-Schlüssel externally_connectable können Sie die Kommunikation jedoch auf bestimmte Erweiterungen beschränken und die Kommunikation mit Websites ermöglichen.
Um eine Nachricht zu senden, die vom onMessageExternal-Listener empfangen wird, verwenden Sie runtime.sendMessage() und übergeben Sie die ID des Empfängers im Parameter extensionId.
Zusammen mit der Nachricht werden dem Listener folgende Argumente übergeben:
- ein
sender-Objekt mit Informationen zum Absender der Nachricht. - eine
sendResponse-Funktion, mit der der Listener dem Absender antworten kann.
Diese API kann nicht in einem Content Script verwendet werden.
Weitere Informationen zum Empfangen von Nachrichten und Senden von Antworten sowie Beispiele für die verschiedenen Antwortmöglichkeiten finden Sie unter runtime.onMessage.
Syntax
browser.runtime.onMessageExternal.addListener()
browser.runtime.onMessageExternal.removeListener(listener)
browser.runtime.onMessageExternal.hasListener(listener)
Ereignisse haben drei Funktionen:
addListener(listener)-
Fügt diesem Ereignis einen Listener hinzu.
removeListener(listener)-
Entfernt den
listener-Listener von diesem Ereignis. hasListener(listener)-
Prüft, ob ein
listenerfür dieses Ereignis registriert ist. Gibttruezurück, wenn dies der Fall ist, andernfallsfalse.
Syntax von addListener
>Parameter
listener-
Die Funktion, die aufgerufen wird, wenn dieses Ereignis eintritt. Der Funktion werden folgende Argumente übergeben:
message-
object. Die Nachricht. Dies ist ein Objekt, das sich in JSON umwandeln lässt. sender-
Ein
runtime.MessageSender-Objekt, das den Absender der Nachricht repräsentiert. sendResponse-
Eine Funktion, die höchstens einmal aufgerufen werden kann, um auf die Nachricht zu antworten. Die Funktion nimmt ein Argument entgegen: ein Objekt, das sich in JSON umwandeln lässt. Dieses Argument wird an den Absender der Nachricht zurückgegeben.
Wenn Sie mehrere
onMessageExternal-Listener im selben Dokument haben, kann nur einer davon eine Antwort senden.Um synchron zu antworten, rufen Sie
sendResponse()auf, bevor die Listener-Funktion zurückkehrt.Um asynchron zu antworten, verwenden Sie eine der folgenden Möglichkeiten:
-
Geben Sie ein
Promiseaus der Listener-Funktion zurück und lösen Sie das Promise auf, sobald die Antwort bereit ist. Dies ist die bevorzugte Vorgehensweise. -
Bewahren Sie eine Referenz auf das Argument
sendResponse()auf und geben Sietrueaus der Listener-Funktion zurück. Rufen Sie anschließendsendResponse()auf, nachdem die Listener-Funktion zurückgekehrt ist.Hinweis: Chrome unterstützt Promise als Rückgabewert ab Chrome 148 oder ab Chrome 152 bei Erweiterungen mit einer DevTools-Seite. Geben Sie für frühere Chrome-Versionen
truezurück und verwenden SiesendResponse, wie fürruntime.onMessagebeschrieben.
-
Beispiele
In diesem Beispiel sendet die Erweiterung „blue@mozilla.org“ eine Nachricht an die Erweiterung „red@mozilla.org“:
// sender: browser.runtime.id === "blue@mozilla.org"
// Send a message to the extension whose ID is "red@mozilla.org"
browser.runtime.sendMessage("red@mozilla.org", "my message");
// recipient: browser.runtime.id === "red@mozilla.org"
function handleMessage(message, sender) {
// check that the message is from "blue@mozilla.org"
if (sender.id === "blue@mozilla.org") {
// process message
}
}
browser.runtime.onMessageExternal.addListener(handleMessage);
Browser-Kompatibilität
Hinweis:
Diese API basiert auf der chrome.runtime-API von Chromium. Diese Dokumentation wurde aus runtime.json im Chromium-Code abgeleitet.