user_scripts

Warnung: Dieser Schlüssel wird durch die Legacy-userScripts-API verwendet, die für Erweiterungen mit Manifest V2 verfügbar ist. Dieser Schlüssel ist nicht erforderlich für die Version der userScripts-API, die mit Manifest V3 verwendet werden kann.

Typ Object
Erforderlich Nein
Manifest-Version 2
Beispiel
json
  "user_scripts": {
    "api_script": "apiscript.js",
  }

Weist den Browser an, ein im Add-on enthaltenes Skript zu laden, bekannt als API-Skript. Dieses Skript wird verwendet, um eine Reihe benutzerdefinierter API-Methoden für die Verwendung in User-Skripten bereitzustellen. Der Pfad des API-Skripts, relativ zur Datei manifest.json, wird als string in "api_script" definiert.

Hinweis: Der Schlüssel user_script ist erforderlich, damit die userScripts-API funktioniert, selbst wenn kein API-Skript angegeben ist. Zum Beispiel: user_scripts: {}.

Das API-Skript:

  • läuft in den Inhaltsprozessen.
  • hat Zugriff auf die window- und document-Globals, die mit der Webseite verbunden sind, auf der es eingesetzt wird.
  • hat Zugriff auf dieselbe Teilmenge der WebExtension-APIs, die normalerweise in einem Content-Script verfügbar sind.

Das Skript wird automatisch auf jeder Webseite ausgeführt, die in matches von userScripts.register() definiert ist. Dies geschieht jedoch, bevor das User-Skript-Sandbox-Objekt erstellt wird und die benutzerdefinierten API-Methoden exportiert werden können.

Um die benutzerdefinierten API-Methoden zu exportieren, hört das Skript auf userScripts.onBeforeScript und exportiert dann die benutzerdefinierten API-Methoden.

Nicht jedes User-Skript muss alle benutzerdefinierten API-Methoden nutzen. Daher können Sie Details zu den benötigten APIs in scriptMetadata angeben, wenn Sie userScripts.register() ausführen. Das API-Skript greift dann über den script-Parameter, der vom userScripts.onBeforeScript-Listener empfangen wird, auf die scriptMetadata zu (als script.metadata).

Browser-Kompatibilität

Siehe auch