userScripts.execute()

Syntax

let executeUserScript = browser.userScripts.execute(
  injection, // array of objects
);

Parameter

injection

Ein Array von Objekten, die spezifizieren, welche Benutzer-Skripte wo und wie eingefügt werden sollen.

injectImmediately Optional

boolean. Wenn auf true gesetzt, wird die Einfügung so schnell wie möglich im Zielkontext ausgeführt. Dies garantiert nicht, dass die Einfügung vor dem Laden der Seite erfolgt, da die Seite möglicherweise geladen wird, bevor das Skript das Ziel erreicht hat.

js

array von userScripts.ScriptSource. Die Skripte, die in die passenden Seiten eingefügt werden sollen.

target

Ein Objekt, das den Zielkontext definiert, in den Skripte eingefügt werden.

allFrames Optional

boolean. Wenn auf true gesetzt, wird das Skript in alle verfügbaren Frames eingefügt. Standardmäßig auf false, wobei das Skript nur in das oberste Frame eingefügt wird.

documentIds Optional

array von string. Die IDs der Dokumente, in die eingefügt werden soll. Darf nicht angegeben werden, wenn frameIds gesetzt ist.

frameIds Optional

array von integer. Die IDs der Frames, in die eingefügt werden soll. Darf nicht angegeben werden, wenn documentIds gesetzt ist.

tabId

integer. Die ID eines Tabs, in den eingefügt werden soll.

world Optional

userScripts.ExecutionWorld. Die Ausführungsumgebung, die verwendet wird, um die Skripte auszuführen. Standardmäßig "USER_SCRIPT".

worldId Optional

string. ID einer Benutzer-Skript-Welt, in der das Skript ausgeführt wird. Nur gültig, wenn world USER_SCRIPT ist oder weggelassen wird. Wenn worldId weggelassen wird, wird das Skript in der Standard-USER_SCRIPT-Welt ("") ausgeführt. Werte mit führenden Unterstrichen (_) sind reserviert. Die maximale Länge beträgt 256 Zeichen. Eine Welt kann von mehreren Skripten als Ausführungsumgebung genutzt werden. Um das Verhalten einer Welt zu konfigurieren, übergeben Sie deren worldId an userScripts.configureWorld bevor das erste Skript in dieser Welt ausgeführt wird.

Rückgabewert

Ein Promise, das mit einem Array von Objekten erfüllt wird, die das Ergebnis der Einfügung mit folgenden Eigenschaften beschreiben:

documentId

string. Dokument-ID, die mit der Einfügung verknüpft ist.

error Optional

string. Fehlermeldung, falls vorhanden. Dies schließt result aus.

frameId

integer. Frame-ID, die mit der Einfügung verknüpft ist.

result Optional

string. Ergebnis der Skript-Einfügung, falls vorhanden. Dies schließt error aus.

Beispiele

await browser.userScripts.execute([
  {
    js: [{ code: "console.log('Hello world!');" }],
    target: { tabId: 1 },
  },
]);

Browser-Kompatibilität