Параметр¶
Именованное значение, необходимое для функция. Например,
встроенный Для функции command требуется один параметр с именем command. Вы
предоставляете параметр значения на кнопке кнопка.
Некоторые параметры являются обязательными; другие являются необязательными, их значения по умолчанию определены в файл функции.
Передаем значение из кнопки¶
Напишите имя параметра в виде ключа прямо на кнопке. Встроенный Поля command,
path и args следуют этому правилу, а специальный параметр имена работают
таким же образом.
Укажите имена пользовательских параметров
unit и lines должны быть объявлены journal-unit. Числовое значение для
lines не нуждается в кавычках.
Не использовать вложенную карту params:
Файл пользовательской функции использует params: для объявления своих
параметров. Кнопка нет. Поместите host:, unit: или любое другое значение
непосредственно на кнопку.
Проверка¶
validate проверяет, что:
- каждый обязательный параметр имеет значение;
- каждое значение кнопки объявлено ее функцией;
- значения, объявленные как
int, содержат целое число; - значения, объявленные как
bool, содержат допустимое логическое значение; - значения по умолчанию соответствуют заявленному типу параметра.
Необязательные параметры используют значения по умолчанию, если кнопка их не включает.
Названия параметров не могут совпадать с настройками кнопок: name, type,
icon, id, function, confirm, timeout, workdir, env, columns или
items. Допускаются имена command, path и args.
См. Функции → Передача значений из кнопки для полного объяснения и примеров.
Конфигурация¶
Информацию о настройках кнопок и клавишах параметров см. Конфигурация → Меню.