Parameter

Ein benannter Wert, den eine Funktion benötigt. Die integrierte Funktion command benötigt beispielsweise einen Parameter namens command. Sie geben Parameterwerte auf der Schaltfläche an.

Einige Parameter sind erforderlich, andere sind optional und besitzen einen in der Funktionsdatei definierten Standardwert.

Einen Wert von einer Schaltfläche übergeben

Schreiben Sie den Parameternamen als Schlüssel direkt auf die Schaltfläche. Die integrierten Felder command, path und args folgen dieser Regel; eigene Parameternamen funktionieren genauso.

Eigene Parameternamen angeben

Aktuelle Dienstprotokolle

- name: nginx-Protokolle
  type: button
  function: journal-unit
  unit: "nginx.service"
  lines: 100

unit und lines müssen von journal-unit deklariert sein. Der numerische Wert für lines muss nicht in Anführungszeichen stehen.

Verwenden Sie keine verschachtelte params:-Zuordnung

Eine Datei für eine eigene Funktion verwendet params:, um ihre Parameter zu deklarieren. Eine Schaltfläche tut dies nicht. Schreiben Sie host:, unit: oder jeden anderen Wert direkt auf die Schaltfläche.

Validierung

validate prüft Folgendes:

• Für jeden erforderlichen Parameter ist ein Wert vorhanden.
• Jeder Wert auf der Schaltfläche ist von ihrer Funktion deklariert.
• Als int deklarierte Werte enthalten eine Ganzzahl.
• Als bool deklarierte Werte enthalten einen gültigen booleschen Wert.
• Standardwerte entsprechen dem deklarierten Parametertyp.

Für ausgelassene optionale Parameter wird der jeweilige Standardwert verwendet.

Parameternamen dürfen nicht mit Schaltflächeneinstellungen übereinstimmen: name, type, icon, id, function, confirm, timeout, workdir, env, columns oder items. Die Namen command, path und args sind zulässig.

Die vollständige Erklärung und Beispiele finden Sie unter Funktionen → Werte von einer Schaltfläche übergeben.

Konfiguration

Informationen zu Schaltflächeneinstellungen und Parameterschlüsseln finden Sie unter Konfiguration → Menü.

Verwandte Themen

• Funktion — was Parameter verwendet
• Regeln — Parameterregeln für eigene Funktionen