UserScripts.UserScriptOptions (Legacy)

Warnung: Dies ist die Dokumentation für das Legacy-userScripts-API. Es ist in Firefox für Manifest V2 verfügbar. Für die Funktionalität von Nutzerskripten in Manifest V3 siehe das neue userScripts-API.

Das UserScriptOptions-Objekt stellt die Content Scripts dar, 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/deregistrieren).
  • Es unterstützt eine optionale scriptMetadata-Eigenschaft (als ein einfaches JSON-Objekt, das einige Metadaten 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 besitzt entweder eine Eigenschaft mit dem Namen file, die eine URL ist, beginnend beim manifest.json der Erweiterung und zu einer zu registrierenden JavaScript-Datei zeigt, oder eine Eigenschaft mit dem Namen code, die JavaScript-Code enthält, der registriert werden soll.

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 Nutzerskripte.

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