commands.update()

Ändern Sie die Beschreibung oder die Tastenkombination für den angegebenen Befehl.

Dies ist eine asynchrone Funktion, die ein Promise zurückgibt.

Syntax

js
browser.commands.update(
  details // object
);

Parameter

details

object. Ein Objekt mit den folgenden Eigenschaften:

name

string. Der Name des zu aktualisierenden Befehls. Dieser muss mit dem Namen eines vorhandenen Befehls übereinstimmen, wie er beispielsweise in der name-Eigenschaft des commands.Command-Objekts angegeben ist.

description Optional

string. Eine neue Beschreibung, die für den Befehl festgelegt werden soll.

shortcut Optional

string. Eine neue Tastenkombination, die für den Befehl festgelegt werden soll. Diese kann sein:

  • ein leerer String, um die Tastenkombination zu entfernen.
  • ein String, der dem Format des commands manifest.json key entspricht, um einen neuen Tastenkurzbefehl festzulegen. Wenn der String diesem Format nicht entspricht, wirft die Funktion einen Fehler.

Rückgabewert

Ein Promise, das ohne Argumente erfüllt wird, wenn die Tastenkombination aktualisiert wurde. Das Promise wird mit einem Fehler abgelehnt, wenn der Befehl nicht gefunden werden konnte.

Browser-Kompatibilität

BCD tables only load in the browser

Beispiele

Aktualisiert den Befehl mit dem Namen "my-command" mit dem angegebenen Tastenkombinationswert, wenn der Benutzer auf "update" klickt:

js
const commandName = "my-command";

function updateShortcut() {
  browser.commands.update({
    name: commandName,
    shortcut: document.querySelector("#shortcut").value,
  });
}

document.querySelector("#update").addEventListener("click", updateShortcut);

Beispiel-Erweiterungen