Методы JS API

Описание:

Метод позволяет найти код текущего встроенного приложения

Сигнатура метода:

function findApplicationCode() : string

Исключения:

• Error — приложение открыто не внутри iframe

Описание:

Метод уведомляет SMP о том, что атрибут редактируется встроенным приложением.

Если приложение выведено на формах добавления /редактирования, то значение данного атрибута будет установлено в результат функции resultCallback

Сигнатура метода:

function registerAttributeToModification(attributeCode : string, resultCallback : Function) : Void

Описание аргументов:

• attributeCode — код атрибута, значение которого редактируется встроенным приложением;
• resultCallback — функция, которая вызывается во время сохранения формы. Результат выполнения функции принимается за значение атрибута

Исключения:

• TypeError — attributeCode не является строкой;
• TypeError — resultCallback не является функцией

Описание:

Метод определяет, находится ли встроенное приложение на форме добавления (полноэкранной форме добавления и форме быстрого добавления)

Сигнатура метода:

function isAddForm() : Boolean

Описание:

Метод определяет, находится ли встроенное приложение на полноэкранной форме редактирования, форме быстрого редактирования, форме смены типа, форме смены статуса, форме смены ответственного, форме смены привязки, форме добавления и редактирования комментария/ файла

Сигнатура метода:

function isEditForm() : Boolean

Описание:

Метод для получения объекта, соответствующего текущему пользователю.

Доступен в мобильном приложении

Сигнатура метода:

function getCurrentUser()

Структура возвращаемого значения:

{
   uuid: string // UUID пользователя
}

Описание:

Метод возвращает значение, заданное в параметре baseurl в dbaccess.properties

Сигнатура метода:

function getAppBaseUrl() : string

Описание:

Метод возвращает URL до REST сервисов

Сигнатура метода:

function getAppRestBaseUrl() : string

Описание:

Метод возвращает режим отображения встроенного приложения: развернуто на весь экран (fullScreen) или нормальный режим (normal)

Сигнатура метода:

function getViewMode() : string

Описание:

Метод выполняет REST запрос на сервер SMP.

Доступен в мобильном приложении

Сигнатура метода:

function restCall(restOfTheUrl : string, options : Object) : Promise<string, Object>

Описание аргументов:

• restOfTheUrl — весь URL, начиная с имени REST метода.

  Пример:

  'exec/?func=modules.moduleName.functionName&params='

• options — опции для конфигурации запроса

  {
    method: string,
    headers: {[key: string]: string},
    body: string | {[key: string]: string}
    responseType: string 
  }

  где:

  • method — метод для обращения к URL;
  • headers — имена свойств == имена заголовков, значения свойств == значения заголовков;

  • body — строка, которая будет записана в тело запроса или

    объект, который будет превращен в строку в виде property1=value1&property2=value2;

  • responseType — тип ответа сервера:

    • "text" — результат в виде текста;
    • "json" — результат в виде JSON;
    • "blob" — результат в виде Blob;
    • "arraybuffer" — результат в виде буфера данных (ArrayBuffer)

Структура возвращаемого значения:

Если запрос завершен успешно и код ответа находится в диапазоне [200;300), то Promise содержит ответ сервера в виде строки.

Если произошла ошибка, то Promise отклоняется и в ответе приходит объект в формате:

{
status: Number, // код ответа
statusText: string, // расшифровка кода ответа
responseText: string // ответ сервера
}

Пример GET-запроса:

const subjectUuid = jsApi.extractSubjectUuid();
const contentCode = jsApi.findContentCode();
const url = `exec/?func=modules.testModule.testMethod&params='${subjectUuid}', '${contentCode}'`;

jsApi.restCall(url, {})
    .then(stringifiedResponse => {
        const response = JSON.parse(stringifiedResponse);
        console.log(response);
        return void 0;
    }).catch(error => {
        console.error(error);
    });

Описание:

Метод выполняет REST запрос на сервер SMP.

Доступен в мобильном приложении

Сигнатура метода:

function restCallAsJson(restOfTheUrl : string, options : Object) : Promise<Object, Object>

Описание аргументов:

• restOfTheUrl — весь URL, начиная с имени REST метода

  Пример:

  'exec/?func=modules.moduleName.functionName&params='

• options — опции для конфигурации запроса

  {
    method: string,
    headers: {[key: string]: string},
    body: string | {[key: string]: string}
    responseType: string 
  }

  где:

  • method — метод для обращения к URL;
  • headers — имена свойств == имена заголовков, значения свойств == значения заголовков;

  • body — строка, которая будет записана в тело запроса или

    объект, который будет превращен в строку в виде property1=value1&property2=value2;

  • responseType — тип ответа сервера:

    • "text" — результат в виде текста;
    • "json" — результат в виде JSON;
    • "blob" — результат в виде Blob;
    • "arraybuffer" — результат в виде буфера данных (ArrayBuffer)

Структура возвращаемого значения:

Если запрос завершен успешно и код ответа находится в диапазоне [200;300), то Promise содержит ответ сервера, разобранный методом JSON.parse.

Если произошла ошибка, то Promise отклоняется и в ответе приходит объект в формате:

{
status: Number, // код ответа
statusText: string, // расшифровка кода ответа
responseText: string // ответ сервера
}

Пример GET-запроса:

const subjectUuid = jsApi.extractSubjectUuid();
const contentCode = jsApi.findContentCode();
const url = `exec/?func=modules.testModule.testMethod&params='${subjectUuid}', '${contentCode}'`;

jsApi.restCallAsJson(url, {})
    .then(response => {
        console.log(response);
        return void 0;
    }).catch(error => {
        console.error(error);
    });

Описание:

Метод вызывает произвольный метод любого скриптового модуля При использовании в контексте встроенного приложения, обращение происходит по следующему правилу:

• Если есть модуль с кодом "<код встроенного приложения>_<moduleCode>", то метод вызывается в нем.
• Если такого модуля нет, то вызываем метод модуля с кодом "<moduleCode>"

Доступен в мобильном приложении

Сигнатура метода:

function restCallModule(moduleCode : string, functionName : string, args: ...Object) : Promise<Object, Object>

Описание аргументов:

• moduleCode — код скриптового модуля;
• functionName — имя метода в скриптовом модуле;
• args — аргументы, которые необходимо передать в функцию. Разрешенные типы аргументов: number, string, boolean, object

Структура возвращаемого значения:

Если запрос завершен успешно и код ответа находится в диапазоне [200;300), то Promise содержит ответ сервера, разобранный методом JSON.parse.

Если произошла ошибка, то Promise отклоняется и в ответе приходит объект в формате:

{
status: Number, // код ответа
statusText: string, // расшифровка кода ответа
responseText: string // ответ сервера
}

Описание:

Команда для открытия формы добавления связи и выбора объекта

Сигнатура метода:

function selectObjectDialog(classFqn : string, presentAttributesGroupCode : string) : Promise<string | null>

Описание аргументов:

• classFqn — FQN класса объектов, которые будут доступны на форме;
• presentAttributesGroupCode — код группы атрибутов, которая будет отображаться на форме

Структура возвращаемого значения:

Возвращается Promise<string | null>, который вернет UUID выбранного объекта или null, если объект не был выбран

Описание:

Команда для смены статуса объекта.

Если статусов больше одного или при входе в статус есть обязательные для заполнения атрибуты, открывается форма смены статуса

Сигнатура метода:

function changeState(uuid : string, states : string[]) : Void

Описание аргументов:

• uuid — UUID объекта, чей статус нужно поменять;
• states — коды целевых статусов

Описание:

Команда для перехода на форму редактирования объекта

Сигнатура метода:

function editObject(uuid : string) : Void

Описание аргументов:

• uuid — UUID объекта, на чью форму редактирования будет совершен переход

Описание:

Команда для вызова формы быстрого добавления объекта

Сигнатура метода:

function quickAddObject(classFqn : string, formCode : string, properties : Map<string, Object>, callback : Function) : Void

Описание аргументов:

• classFqn — FQN класса или типа, в котором настроена форма быстрого добавления;
• formCode — код формы быстрого добавления;

• properties — значения атрибутов, которые необходимо предварительно заполнить на форме.

  Ключом является код атрибута. Значение зависит от типа атрибута. Допустимые значения описаны в разделе Формат передачи данных.

  Недопустимые значения не предзаполняются. Атрибуты, отсутствующие на форме, не предзаполняются;

• callback — функция, которая вызывается по результату работы формы.

  Сигнатура функции:

  function callback(uuid : string, exception : Error)

  Параметры функции:

  • uuid — идентификатор созданного объекта или null (если пользователь отказался от создания);
  • exception — исключение, если возникла ошибка

Описание:

Команда для вызова формы быстрого редактирования объекта

Сигнатура метода:

function quickEditObject(uuid : string, formCode : string, properties : Map<string, Object>, callback : Function) : Void

Описание аргументов:

• uuid — UUID редактируемого объекта
• formCode — код формы быстрого редактирования
• properties — значения атрибутов, которые необходимо предварительно заполнить на форме. Допустимые значения описаны в разделе Формат передачи данных.

• callback — функция, которая вызывается по результату работы формы.

  Сигнатура функции:

  function callback(uuid : string, exception : Error)

  Параметры функции:

  • uuid — uuid отредактированного объекта или null (если пользователь отказался от редактирования);
  • exception — исключение, если возникла ошибка

Описание:

Метод делает запрос на указанный URL. Является оберткой над XmlHttpRequest.

Доступен в мобильном приложении

Сигнатура метода:

function make(options : Object) : Promise<string, Object>

Описание аргументов:

• options — опции для конфигурации запроса

  {
    url: string,
    method: string,
    headers: {[key: string]: string},
    body: string | {[key: string]: string}
    responseType: string 
  }

  где:

  • url — URL, на который будет отправлен запрос;
  • method — метод для обращения к URL;
  • headers — имена свойств == имена заголовков, значения свойств == значения заголовков;

  • body — строка, которая будет записана в тело запроса или

    объект, который будет превращен в строку в виде property1=value1&property2=value2;

  • responseType — тип ответа сервера:

    • "text" — результат в виде текста;
    • "json" — результат в виде JSON;
    • "blob" — результат в виде Blob;
    • "arraybuffer" — результат в виде буфера данных (ArrayBuffer)

Структура возвращаемого значения

Если запрос завершен успешно и код ответа находится в диапазоне [200;300), то Promise содержит ответ сервера в виде строки.

Если произошла ошибка, то Promise отклоняется и в ответе приходит объект в формате:

{
status: Number, // код ответа
statusText: string, // расшифровка кода ответа
responseText: string // ответ сервера
}

Пример GET-запроса:

const appRestBaseUrl = jsApi.getAppRestBaseUrl();
const subjectUuid = jsApi.extractSubjectUuid();
const url = `${appRestBaseUrl}/get/${subjectUuid}?attrs=title,UUID`;

jsApi.requests.make({url})
    .then(stringifiedResponse => {
        const response = JSON.parse(stringifiedResponse);
        console.log(response);
        return void 0;
    }).catch(error => {
        console.error(error);
    });

Описание:

Метод делает запрос на указанный URL. Является оберткой над XmlHttpRequest.

Доступен в мобильном приложении

Сигнатура метода:

function json(options : Object) : Promise<Object, Object>

Структура возвращаемого значения:

Если запрос завершен успешно и код ответа находится в диапазоне [200;300), то Promise содержит ответ сервера, разобранный методом JSON.parse.

Если произошла ошибка, то Promise отклоняется и в ответе приходит объект в формате:

{
status: Number, // код ответа
statusText: string, // расшифровка кода ответа
responseText: string // ответ сервера
}

Пример GET-запроса:

const appRestBaseUrl = jsApi.getAppRestBaseUrl();
const subjectUuid = jsApi.extractSubjectUuid();
const url = `${appRestBaseUrl}/get/${subjectUuid}?attrs=title,UUID`;

jsApi.requests.json({url})
    .then(response => {
        console.log(response);
        return void 0;
    }).catch(error => {
        console.error(error);
    });

Описание:

Метод возвращает URL интерфейса оператора

Сигнатура команды:

function base() : string

Описание:

Метод возвращает URL на карточку объекта

Сигнатура команды:

function objectCard(uuid : string) : string

Описание аргумента:

• uuid — UUID объекта, на карточку которого нужно сгенерировать ссылку

Описание:

Метод возвращает URL на форму добавления объекта

Сигнатура команды:

function objectAddForm(fqn : string) : string

Описание аргумента:

• fqn — FQN класса, на форму добавления которого нужно сгенерировать ссылку

Описание:

Метод возвращает URL на форму редактирования

Сигнатура команды:

function objectEditForm(uuid : string) : string

Описание аргумента:

• uuid — UUID объекта, на форму редактирования которого нужно сгенерировать ссылку

Описание:

Метод предназначен для конфигурирования встроенного приложения через скриптовый модуль в SMP. Вызывает функцию в скриптовом модуле, имя которой равняется коду контента, в котором выведено встроенное приложение.

Доступен в мобильном приложении

Сигнатура метода:

function byContentCode(moduleCode : string, args: ...Object) : Promise<Object, Object>

Описание аргументов:

• moduleCode — код модуля, функция которого будут вызываться;
• args — аргументы, которые необходимо передать в функцию. Разрешенные типы аргументов: number, string, boolean, object

Структура возвращаемого значения:

Если запрос завершен успешно и код ответа находится в диапазоне [200;300), то Promise содержит ответ сервера, разобранный методом JSON.parse.

Если произошла ошибка, то Promise отклоняется и в ответе приходит объект в формате:

{
status: Number, // код ответа
statusText: string, // расшифровка кода ответа
responseText: string // ответ сервера
}

Описание:

Сигнатура метода:

function subscribe(destination : string, callback : Function) : Void

Описание аргументов:

• destination — адрес в WebSocket канале, на который подписываемся, может представлять из себя произвольную строку;

• callback — функция, вызвана при приходе сообщения через WebSocket канал, на адрес destination.

  Сигнатура функции:

  function callback(message : Frame)

  где message — полученный фрейм с данными, само сообщение можно получить так: message.body

Описание:

Сигнатура метода:

function unsubscribe(destination : string) : Void

Описание аргумента:

• destination — адрес в WebSocket канале, от рассылки на который отписываемся, может представлять из себя произвольную строку

Описание:

Метод предназначен для подключения к брокеру сообщений, передаваемых через WebSocket канал

Сигнатура метода:

function connect(callback : Function) : Void

Описание аргумента:

• callback — функция, вызвана после подключения к брокеру сообщений

  Сигнатура функции:

  function callback() : Void

Описание:

Метод предназначен для отключения от брокера сообщений, передаваемых через WebSocket канал

Сигнатура метода:

function disconnect() : Void

Описание:

Метод предназначен для отправки сообщения в определенный адрес через WebSocket канал. Автоматически подключается к брокеру сообщений перед отправкой, если еще не подключены

Сигнатура метода:

function send(destination : string, message : string) : Void

Описание аргументов:

• destination — адрес в WebSocket канале, в который отправляем сообщение, может представлять из себя произвольную строку;
• message — отправляемое сообщение, может представлять из себя произвольную строку

Описание:

Подписка на изменение значения атрибута на форме добавления /редактирования объекта

Сигнатура метода:

function addFieldChangeListener(attrCode : string, callback : Function)

Описание аргументов:

• attrCode — код атрибута, на изменения которого производится подписка;

• callback — функция, которая будет вызвана при изменении атрибута.

  Сигнатура функции:

  function callback(result: Object)

  где result — объект со следующими полями: attribute — код атрибута, изменение которого было произведено, newValue — новое значение атрибута

Структура поля newValue:

В зависимости от типа значения атрибута на форме, newValue будет иметь разные типы значений (формат приведен в разделе "Формат передачи данных"):

• ссылочный (например ссылка на БО);
• перечислимый (например список типов);
• временной интервал;
• null, например, если для ссылочного типа будет выбрано значение [не указано] в поле выбора;
• строковой;
• вложенные в списки атрибуты

Описание:

Подписка на событие выхода из полноэкранного режима приложения

function onFullscreenDisabled(callback : Function)

Описание аргумента:

• callback — функция, которая будет вызвана при выходе из полноэкранного режима.

  Сигнатура функции:

  function callback()

Описание:

Подписка на событие разворачивания приложения на весь экран

Сигнатура метода:

function onFullscreenEnabled(callback : Function)

Описание аргумента:

• callback — функция, которая будет вызвана при разворачивании приложения на весь экран.

  Сигнатура функции:

  function callback()

Описание:

Подписка на событие скрытия контента на карточке /форме по условиям отображения

Сигнатура метода:

function onContentHide(callback : Function)

Описание аргумента:

• callback — функция, которая будет вызвана при скрытии контента по условиям отображения.

  Сигнатура функции:

  function callback()

Описание:

Подписка на событие показа контента на карточке /форме по условиям отображения

Сигнатура метода:

function onContentShow(callback : Function)

Описание аргумента:

• callback — функция, которая будет вызвана при показе контента по условиям отображения.

  Сигнатура функции:

  function callback()

Описание:

Команда для получения объекта из текущего GWT контекста.

Для страниц добавления/редактирования — это текущий добавляемый и редактируемый объект, для карточки объекта — текущий объект.

Доступен в мобильном приложении

Сигнатура метода:

function getValues() : Promise<Object.<string, Object>>

Структура возвращаемого значения:

Promise содержит объект, чьи ключи являются кодами атрибутов, а значения - значениями соответствующего атрибута объекта из текущего контекста

Описание:

Команда вызова формы смены ответственного

Сигнатура метода:

function changeResponsible(uuid : string) : Promise<Object<string, Object>>

Описание аргумента:

• uuid — идентификатор объекта, для которого необходимо вызвать форму

Описание:

Метод определяет, размещено ли встроенное приложение на форме

Сигнатура метода:

function isModal() : boolean

Структура возвращаемого значения:

Методом возвращается boolean

Описание:

Метод определяет тип формы, на которой размещено встроенное приложение

Сигнатура метода:

function getType() : string

Структура возвращаемого значения (метод возвращает string):

• addForm — форма добавления;
• editForm — форма редактирования;
• objectCard — карточка объекта;
• changeStateForm — форма смены статуса;
• changeResponsibleForm — форма изменения ответственного;
• changeCaseForm — форма смены типа;
• changeAssociationForm — форма смены привязки;
• quickAddForm — быстрая форма добавления;
• quickEditForm — быстрая форма редактирования
• addCommentForm — форма добавления комментария;
• editCommentForm — форма редактирования комментария;
• addFileForm — форма добавления файла;
• editFileForm — форма редактирования файла;
• userEventActionForm — форма пользовательского действия по событию

Описание:

Команда для получения параметров, сохраненных в метаинформации контента, в котором находится встроенное приложение.

Доступен в мобильном приложении

Сигнатура метода:

function getParameters() : Promise<Object.<string, Object>>

Структура возвращаемого значения: