Список версий МТ

Главная

api.interactive

Взаимодействие с пользователем

Methods

api.interactive.error(text)
api.interactive.info(text)
api.interactive.inputInt(title, defVal, min, max) → SelectResult
api.interactive.inputReal(title, defVal, min, max, decimals) → SelectResult
api.interactive.inputString(title, currentText, mask, regexp, maxLength) → SelectResult
api.interactive.inputString(title, currentText, params) → SelectResult
api.interactive.inputText(title, currentText, maxLength) → SelectResult
api.interactive.inputText(title, currentText, params) → SelectResult
api.interactive.msgbox(title, text, format)
api.interactive.question(title, text, buttons, name, isModal) → Button
api.interactive.selectDate(title, defVal, min, max) → SelectResult
api.interactive.selectDatePeriod(title, defVal, min, max) → SelectResult
api.interactive.selectDateTime(title, defVal, min, max) → SelectResult
api.interactive.selectMultiItem(title, model, defVal) → SelectResult
api.interactive.selectMultiValue(title, model, defVal) → SelectResult
api.interactive.selectSingleItem(title, model, defVal) → SelectResult
api.interactive.selectSingleValue(title, model, defVal) → SelectResult
api.interactive.selectTime(title, defVal, min, max) → SelectResult
api.interactive.selectTimePeriod(title, defVal, min, max) → SelectResult
api.interactive.warning(text)

Methods description

error(text)

Показать сообщение об ошибке

Parameters:
Name Type Description
text String

Текст

info(text)

Показать информационное сообщение

Parameters:
Name Type Description
text String

Текст

inputInt(title, defVal, min, max) → SelectResult

Ввод числа

Parameters:
Name Type Argument Description
title String

Заголовок
defVal String optional 

Значение по умолчанию
min Number optional 

Минимальное допустимое значение
max Number optional 

Максимально допустимое значение
Return:
SelectResult -

Результат выбора, value содержит введённое число

inputReal(title, defVal, min, max, decimals) → SelectResult

Ввод вещественного числа

Parameters:
Name Type Argument Description
title String

Заголовок
defVal String optional 

Значение по умолчанию
min Number optional 

Минимальное допустимое значение
max Number optional 

Максимально допустимое значение
decimals Number optional 

Число десятичных знаков
Return:
SelectResult -

Результат выбора, value содержит введённое число

inputString(title, currentText, mask, regexp, maxLength) → SelectResult

Ввести строку текста

Parameters:
Name Type Argument Description
title String

Заголовок
currentText String optional 

Значение по умолчанию
mask String optional 

Маска ввода
regexp String optional 

Регулярное выражение
maxLength Number optional 

Максимальное количество знаков (без ограничения по-умолчанию)
Return:
SelectResult -

Результат выбора, value содержит введённую строку

inputString(title, currentText, params) → SelectResult

Ввести строку текста с параметрами

Parameters:
Name Type Description
title String

Заголовок
currentText String

Значение по умолчанию
params StringVerification

Параметры верификации ввода
Return:
SelectResult -

Результат выбора, value содержит введённую строку

inputText(title, currentText, maxLength) → SelectResult

Ввести текст

Parameters:
Name Type Argument Description
title String

Заголовок
currentText String optional 

Значение по умолчанию
maxLength Number optional 

Максимальное количество знаков (без ограничения по-умолчанию)
Return:
SelectResult -

Результат выбора, value содержит введённый текст
Example
const ret = api.interactive.inputText('Введите текст');

if (ret.success) {
    api.interactive.info(`Вы ввели: ${ret.value}`);
} else {
    api.interactive.error('Canceled');
}

inputText(title, currentText, params) → SelectResult

Ввести текст с параметрами

Parameters:
Name Type Description
title String

Заголовок
currentText String

Значение по умолчанию
params StringVerification

Параметры верификации ввода
Return:
SelectResult -

Результат выбора, value содержит введённый текст

msgbox(title, text, format)

Окно с сообщением и кнопкой OK (как alert в JS)

Parameters:
Name Type Argument Default Description
title String optional  Сообщение

Заголовок
text String

Текст сообщения
format String optional  plaintext

Формат текста: 'plaintext' или 'richtext' (HTML)

question(title, text, buttons, name, isModal) → Button

Задать вопрос

Parameters:
Name Type Argument Default Description
title String optional 

Заголовок
text String

Текст вопроса
buttons ButtonList

Кнопки
name String optional 

Имя окна
isModal Boolean optional  true

Признак модального окна
Return:
Button -

Нажатая кнопка

selectDate(title, defVal, min, max) → SelectResult

Выбор даты

Parameters:
Name Type Argument Description
title String

Заголовок
defVal Date optional 

Значение по умолчанию
min Date optional 

Наиболее ранняя дата, доступная для выбора
max Date optional 

Наиболее поздняя дата, доступная для выбора
Return:
SelectResult -

Результат выбора, value содержит выбранную дату (Date)
Example
const ret = api.interactive.selectDate();

if (ret.success) {
    api.log.debug(`Selected: ${ret.value}`);
} else {
    api.log.debug('Canceled');
}

selectDatePeriod(title, defVal, min, max) → SelectResult

Выбор периода дат

Parameters:
Name Type Argument Description
title String

Заголовок
defVal Period optional 

Значение по умолчанию
min Date optional 

Наиболее ранние дата и время, доступные для выбора
max Date optional 

Наиболее поздние дата и время, доступные для выбора
Return:
SelectResult -

Результат выбора, value содержит выбранное время (Date)

selectDateTime(title, defVal, min, max) → SelectResult

Выбор даты и времени

Parameters:
Name Type Argument Description
title String

Заголовок
defVal Date optional 

Значение по умолчанию
min Date optional 

Наиболее ранние дата и время, доступные для выбора
max Date optional 

Наиболее поздние дата и время, доступные для выбора
Return:
SelectResult -

Результат выбора, value содержит выбранную дату и время (Date)

selectMultiItem(title, model, defVal) → SelectResult

Выбор нескольких элементов из списка

Parameters:
Name Type Argument Description
title String

Заголовок
model Array.<Object>

Модель выбора
defVal * optional 

Значение по умолчанию
Return:
SelectResult -

Результат выбора, value содержит список выбранных элементов

selectMultiValue(title, model, defVal) → SelectResult

Выбор нескольких значений из списка

Parameters:
Name Type Argument Description
title String

Заголовок
model Array.<Object>

Модель выбора
defVal * optional 

Значение по умолчанию
Return:
SelectResult -

Результат выбора, value содержит список выбранных значений

selectSingleItem(title, model, defVal) → SelectResult

Выбор одного элемента из списка

Parameters:
Name Type Argument Description
title String

Заголовок
model Array.<Object>

Модель выбора
defVal ID optional 

Значение по умолчанию
Return:
SelectResult -

Результат выбора, value содержит выбранный элемент

selectSingleValue(title, model, defVal) → SelectResult

Выбор одного значения из списка

Parameters:
Name Type Argument Description
title String

Заголовок
model Array.<Object>

Модель выбора
defVal * optional 

Значение по умолчанию
Return:
SelectResult -

Результат выбора, value содержит выбранное значение

selectTime(title, defVal, min, max) → SelectResult

Выбор времени

Parameters:
Name Type Argument Description
title String

Заголовок
defVal Date optional 

Значение по умолчанию
min Date optional 

Наиболее раннее время, доступное для выбора
max Date optional 

Наиболее позднее время, доступное для выбора
Return:
SelectResult -

Результат выбора, value содержит выбранное время (Date)

selectTimePeriod(title, defVal, min, max) → SelectResult

Выбор периода времени

Parameters:
Name Type Argument Description
title String

Заголовок
defVal Period optional 

Значение по умолчанию
min Date optional 

Наиболее раннее время, доступное для выбора
max Date optional 

Наиболее позднее время, доступное для выбора
Return:
SelectResult -

Результат выбора, value содержит выбранное время (Date)

warning(text)

Показать предупреждение

Parameters:
Name Type Description
text String

Текст