user_scripts

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

Weist den Browser an, ein im Add-on verpacktes Skript zu laden, bekannt als das API-Skript. Dieses Skript wird verwendet, um eine Reihe von benutzerdefinierten API-Methoden für die Verwendung in Benutzer-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, auch wenn kein API-Skript angegeben ist. Zum Beispiel. user_scripts: {}.

Das API-Skript:

  • läuft in den Inhaltsprozessen.
  • hat Zugriff auf die globalen Fenster- und Dokumentobjekte, die sich auf die Webseite beziehen, an die es angehängt ist.
  • hat Zugriff auf dasselbe Teilset der WebExtension-APIs, die normalerweise in einem Inhaltsskript verfügbar sind.

Das Skript wird automatisch auf jeder Webseite ausgeführt, die in matches durch userScripts.register definiert ist. Dies geschieht jedoch bevor das Benutzer-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 Benutzer-Skript muss alle benutzerdefinierten API-Methoden verwenden. Sie können daher Details der 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

BCD tables only load in the browser

Siehe auch