Основное

Конструктор интерфейса — это визуальный сборщик панели управления для вашего модуля. Вы собираете форму (поля ввода, переключатели, таблицы, кнопки запуска, вкладки, темы и переводы) без написания кода. Готовый интерфейс превращается в обычную веб-страницу, которая запускает сценарий, передаёт в него введённые данные и показывает ход выполнения в реальном времени.

А если стандартных возможностей не хватает — интерфейс даёт программный API, доступный из вашего собственного JavaScript прямо внутри страницы. Этот раздел описывает и принцип работы, и весь публичный API.

Ключевые понятия

• Интерфейс — веб-страница, собранная в конструкторе. Работает в приложении или в браузере.
• Сценарий — рабочий процесс, который выполняет движок. Состоит из функций; точка входа — функция Main.
• Ресурс — элемент интерфейса, куда пользователь вводит данные для сценария (поле, переключатель, список, таблица). У ресурса есть имя, по которому к нему обращаются.
• Переменная — именованное значение внутри выполняющегося сценария (локальная или глобальная).
• Поток — независимая линия выполнения; сценарий можно запустить сразу в несколько потоков.
• Задача — самостоятельный параллельный процесс рядом с основным сценарием.
• Движок — исполнительное ядро, запускающее сценарии, потоки и задачи.

Два глобальных объекта

Любой сгенерированный интерфейс предоставляет два глобальных объекта в JavaScript:

Engine.api — рекомендуемый фасад, собирающий все возможности в удобные пространства имён:

Engine.api.engine        // сценарий, потоки, переменные, ресурсы
Engine.api.ui            // тема, язык, ресурсы, вкладки, навигация, состояние
Engine.api.dialog        // уведомления, подтверждения, запрос ввода
Engine.api.modal         // модальные окна
Engine.api.database      // работа с таблицами компонента «база данных»
Engine.api.electron      // файлы, системные диалоги, буфер обмена (в приложении)
Engine.api.log           // журнал логов
Engine.api.scenarioView  // панель хода выполнения
Engine.api.eventListener // подписка на события движка
Engine.api.visibility    // условная видимость элементов

InterfaceRuntime — прямой доступ к отдельным модулям и к двум хранилищам разработчика:

InterfaceRuntime.KV  // асинхронное хранилище «ключ-значение»
InterfaceRuntime.DB  // прямой доступ к SQL-базе (только в приложении)

Единый контракт результата

Почти все методы Engine.api возвращают объект одного вида, поэтому результат удобно проверять всегда одинаково:

const res = Engine.api.ui.getResource('userName');
if (res.success) {
  console.log('Значение:', res.data);
} else {
  console.warn('Ошибка:', res.error);
}

Асинхронные методы возвращают Promise, разрешающийся таким же объектом — их удобно вызывать через await.

Разделы

Внутри раздела Веб-интерфейс собран весь программный API: