Методы FrontendCore

Этот раздел содержит описание методов, которые используются при написании кода экранных форм в файле с расширением mdcontainer.

FrontendCore — это JS-библиотека, которая распространяется как пакет NPM и содержит описание методов для работы с компонентами экранных форм в DevTools.

Методы FrontendCore описаны в следующей таблице.

Имя метода	Параметры: назначение и тип	Выполняемое действие
addMessage	message: string, variant: enum, persist: boolean, button?: array {text: string, style: string, icon: string, onClick: event}	Выводит всплывающее уведомление с текстом message, типа variant (info, error, success, warning) и с возможностью persist закрытия всплывающего уведомления вручную. Может содержать массив объектов button для добавления кнопок в области уведомления. Для кнопки указывают текст text, стиль style (Tertiary, TertiaryError или TertiaryGray), имя значка icon, обработчик события onClick для задания переменных состояния экранной формы или реализации иного функционала в разрабатываемом приложении.
addSubscriber	taskId: string или регулярное выражение, methodName: string	Реализует подписку на уведомления сервера. Добавляет слушателя сокета по идентификатору задачи и указывает имя метода, который необходимо выполнить после получения уведомления.
Alert	message: string	Отображает стандартное диалоговое окно с предупреждающим сообщением и кнопкой ОК.
Confirm	message: string	Отображает стандартное диалоговое окно с сообщением и кнопками ОК и Отмена.
detectBrowserVersion	-	Возвращает версию текущего браузера в виде числа.
endSpan	key: string	Останавливает замер с заданным идентификатором key. В качестве замера может выступать, например, время выполнения фрагмента кода.
executeAction	commandName: string, params: any	Вызывает команду по имени. Автоматически определяет тип вызываемой команды на основании значения поля Type в actions.js. Заменяет sendCommand, sendDataSet, sendGraphQL. Пример: executeAction('getBook', {id: 123})
getCommand	{Command: string, Data?: any, History?: any, Container?: string, projectId?: string, }	Возвращает набор данных, который в дальнейшем будет передан в методы, принимающие команды в качестве параметров: SendCommand, SendDataSet, SendGraphQL.
getCommonProperties	-	Возвращает свойства, являющиеся общими для всех компонентов.
getControls	-	Возвращает список всех компонентов.
getControlVariant	-	Возвращает выбранный вариант компонента.
getCoreVersion	-	Возвращает версию пакета FrontendCore.
getDataSource	name: string	Возвращает источник данных по имени name.
getEvent	-	Возвращает объект события мыши или клавиатуры.
getFunction	functionName: string	Возвращает метод по имени functionName из functions.js.
getGlobalValue	key: string	Возвращает значение в UserSettingService по ключу key.
getHelp	id: number	Возвращает справку из helpService по идентификатору страницы id.
getLocale	-	Возвращает текущую локаль пользователя.
getLocalization	key: string	Возвращает перевод по заданному ключу.
getLocalValue	key: string	Возвращает информацию из localStorage в _tempstorage по заданному ключу.
getOldBrowserFixClass	version: number	Сравнивает версию version браузера с минимальной поддерживаемой версией браузера. Возвращает минимально поддерживаемую версию браузера, либо пустую строку.
getProp	propName: string	Возвращает объект свойства с заданным именем.
getRemainingDate	date: объект Date	Возвращает значение времени, прошедшее от заданной даты до текущего момента, в человекочитаемом виде. Пример возвращаемого значения: 4 years ago.
getToken	-	Возвращает токен авторизации.
getUser	-	Возвращает объект пользователя.
getValidation	functionName: string	Возвращает метод валидации по имени из validations.js.
getValue	key: string, {byRef: boolean}	Возвращает значение переменной по ключу из values.js. При установленном в true флаге byRef возвращает ссылку на переменную состояния экранной формы. С помощью флага getValueByRef в settings.json можно задать поведение метода getValue по-умолчанию.
isDevelopmentMode	-	Возвращает true, если приложение запущено в режиме разработки.
isMobile	-	Возвращает true, если приложение запущено на мобильном устройстве.
Prompt	message: string	Отображает стандартное диалоговое окно с сообщением, текстовым полем для ввода данных и кнопками ОК и Отмена.
removeSubscriber	taskId: string или регулярное выражение	Реализует отписку от уведомлений сервера и удаляет слушателя сокета.
self	-	Возвращает контекст выполнения. Устаревший метод.
sendCommand	argument: { Command: string, Data?: any, History?: any, Container?: string, projectId?: string,} или commandName: string, data: string	Вызывает команду. Примеры: sendCommand(argument); sendCommand(arg1, arg2)
sendDataSet	argument: {Command, Data?, Container }, Container?	Отправляет команду для получения набора данных.
sendGraphQL	{ Command, Variables?, Query? }	Отправляет команду для вызова GraphQL-запроса.
sendQuery		Метод использовался до реализации sendGraphQL, который является заменой. Устаревший метод.
setGlobalValue	key:string, value:string	Записывает заданное значение в UserSettingService.
setLocalValue	key: string, value: string	Устанавливает в localStorage значение value по ключу key.
setLocale	value: string	Устанавливает локаль для текущего пользователя.
setState	obj: object (объект, хранящий состояние переменных в heap), settings: либо boolean, тогда этот параметр используется для установки значения переменной в heap; либо объект следующей структуры: { toRoot: boolean, toMasterPage: boolean }	Обновляет состояние компонента. Аналогично механизму state/setState в react hooks. Позволяет изменять состояние родительских компонентов. В зависимости от того, что передано в качестве параметра settings — только boolean или объект { toRoot: boolean, toMasterPage: boolean } — место хранения значения меняется. При передаче в качестве параметра объекта Root, для всех контейнеров доступны переменные состояния.
showErrorContainer	-	Выбрасывает исключение.
startSpan	key: string	Запускает замер с заданным идентификатором. В качестве замера может выступать, например, время выполнения фрагмента кода.
subtractDate	date: number, type: string	Вычитает заданное количество date временных единиц type (см. <https://momentjscom.readthedocs.io/en/latest/moment/03-manipulating/02-subtract/>).
stopEvent	-	Останавливает текущее событие.
validate	someObject: object	Возвращает результирующее значение модели валидации: true или false. Метод может использоваться для объекта или массива объектов. Проверяет, имеет ли каждый ключ переданного в качестве параметра объекта someObject значение true. Ключ имеет значение true, если он не является null, undefined, 0 или false.