commands.update()

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

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 bestehenden 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 löschen.
  • ein String, der dem Format des commands manifest.json Schlüssels entspricht, um eine neue Tastenkombination festzulegen. Wenn der String dieses Format nicht erfüllt, löst die Funktion einen Fehler aus.

    Hinweis: Ab Firefox 135 können Erweiterungen mit dieser Methode die Tasten F13 bis F19 zusätzlich zu den von commands unterstützten Tasten zuweisen.

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

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Firefox for Android
Safari on iOS
update
description
name
shortcut

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support
See implementation notes.

Beispiele

Aktualisiert den Befehl mit dem Namen "my-command" mit dem angegebenen Shortcut-Wert, 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);

Beispielerweiterungen