UserScripts.UserScriptOptions (Legacy)

Warnung: Dies ist die Dokumentation für die veraltete userScripts API. Sie ist in Firefox für Manifest V2 verfügbar. Für die Funktionalität der Benutzerskripte in Manifest V3 siehe die neue userScripts API.

Das UserScriptOptions-Objekt repräsentiert die Content-Skripte, die registriert werden sollen. Es hat eine ähnliche Syntax wie die contentScript-Optionen, die von browser.contentScripts.register unterstützt werden. Die Unterschiede sind:

  • Es unterstützt keine CSS-Eigenschaft (verwenden Sie browser.contentScripts.register, um Stylesheets dynamisch zu registrieren/abzumelden).
  • Es unterstützt eine optionale scriptMetadata-Eigenschaft (als einfaches JSON-Objekt, das einige Metadaten-Eigenschaften enthält, die mit den registrierten userScripts verbunden sind).

Das UserScriptOptions-Objekt hat die folgenden Eigenschaften:

allFrames Optional

Entspricht all_frames im content_scripts-Schlüssel.

excludeGlobs Optional

Entspricht exclude_globs im content_scripts-Schlüssel.

excludeMatches Optional

Entspricht exclude_matches im content_scripts-Schlüssel.

includeGlobs Optional

Entspricht include_globs im content_scripts-Schlüssel.

js Optional

Ein Array von Objekten. Jedes Objekt hat entweder eine Eigenschaft namens file, die eine URL ist, die beim Manifest.json der Erweiterung beginnt und auf eine zu registrierende JavaScript-Datei zeigt, oder eine Eigenschaft namens code, die JavaScript-Code zur Registrierung ist.

matchAboutBlank Optional

Entspricht match_about_blank im content_scripts-Schlüssel.

matches

Entspricht matches im content_scripts-Schlüssel.

runAt Optional

Entspricht run_at im content_scripts-Schlüssel.

scriptMetadata Optional

Ein Metadatenwert für Benutzerskripte.

Es hat eine ähnliche Syntax wie die contentScript-Optionen, die von browser.contentScripts.register unterstützt werden.