user_scripts
Warnung:
Dieser Schlüssel wird von der veralteten userScripts-API verwendet, die für Erweiterungen mit Manifest V2 verfügbar ist. Dieser Schlüssel ist für die Version der userScripts-API, die mit Manifest V3 verwendet werden kann, nicht erforderlich.
| Typ | Object |
|---|---|
| Verpflichtend | Nein |
| Manifest-Version | 2 |
| Beispiel |
json |
Weist den Browser an, ein im Add-on gepacktes Skript zu laden, das als API-Skript bekannt ist. Dieses Skript wird verwendet, um eine Reihe benutzerdefinierter API-Methoden zur Verwendung in Benutzerskripten zu exportieren. Der API-Skriptpfad, relativ zur Datei manifest.json, wird im "api_script" als string definiert.
Hinweis:
Der user_script-Schlüssel 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
window- unddocument-Objekte, die mit der Webseite verbunden sind, an die es angehängt ist. - hat Zugriff auf denselben Unterbereich der WebExtension-APIs, die normalerweise in einem Inhaltsskript 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 Benutzerskript-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 Benutzerskript 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, den es vom userScripts.onBeforeScript-Listener erhält (als script.metadata), auf das scriptMetadata zu.