api.web Формирование ссылок, ведущих в мобильное приложение

Ссылка на комментарий в мобильном приложении

api.web.openCommentInList(objUUID, commentUUID)

Генерация URL-ссылки для позиционирования на конкретном комментарии в списке комментариев определенного объекта.

Параметры метода:
- objUUID — uuid объекта;
- commentUUID — uuid комментария, на котором необходимо позиционироваться.
  
  Допустимо использование sourceObject — в случае события "добавление комментария" возвращается добавленный комментарий.
Возвращает строку, содержащую URL-ссылку для позиционирования на конкретном комментарии в списке комментариев определенного объекта.

Пример. Ссылка для позиционирования на комментарии commentUUID в списке комментариев в объекте subject:

pushMobile.link << api.web.openCommentInList(subject.UUID, "commentUUID")

Ссылка на файл в списка файлов в мобильном приложении

api.web.openFileInList(objUUID, fileUUID)

Генерация URL-ссылки для позиционирования на конкретном файле в списке файлов определенного объекта.

Параметры метода:
- objUUID — uuid объекта;
- fileUUID — uuid файла, на котором необходимо позиционироваться.
  
  Возможно использование sourceObject — в случае события "прикрепление файла к объекту" возвращает прикрепленный файл.
Возвращает строку, содержащую URL-ссылку для позиционирования на конкретном файле в списке файлов определенного объекта.

Пример. Ссылка для позиционирования на файле fileUUID в списке файлов в объекте subject:

pushMobile.link << api.web.openFileInList(subject.UUID, "fileUUID")

Ссылка на объект списка в мобильном приложении

api.web.openObjectInList(listUUID, objUUID)

Генерация URL-ссылки для позиционирования на конкретном объекте в списке объектов.

Параметры метода:
- listUUID — uuid списка объектов в мобильном приложении (отображается в url-строке в настройках списков мобильного приложения);
- objUUID — идентификатор объекта, на который позиционируется ссылка.
Возвращает строку, содержащую URL-ссылку для позиционирования на конкретном объекте в списке объектов.

Пример. Ссылка для позиционирования на объекте subject в списке объектов с UUID "f9eceb6e-1549-0b63-0001-00001417f2b7":

pushMobile.link <<api.web.openObjectInList('f9eceb6e-1549-0b63-0001-00001417f2b7', subject.UUID)

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

api.web.edit(subject, mobileForm)

api.web.edit(subject, mobileForm, attributes)

api.web.edit(subject, login_or_accesskey, mobileForm)

Генерация URL-ссылки для перехода на форму редактирования в мобильном приложении.

Параметры метода:
- subject — объект, форма редактирования которого будет открыта при переходе по ссылке;
- login_or_accesskey — логин или ключ авторизации пользователя для входа в систему (по имени пользователя или по uuid пользователя), см. api.auth Работа с ключами авторизации.
- mobileForm — код формы редактирования в мобильном приложении. Может быть null.
  
  Если параметр указан, то ссылка будет содержать код формы редактирования и при переходе по ссылке в мобильном приложении будет открыта указанная форма редактирования.
- attributes — ассоциативный массив, содержащий значения атрибутов, передаваемых на форму редактирования: ключ — код атрибута; значение — значение атрибута
  
  Доступные типы атрибутов: BOLinks, BOLink, BackLink, CatalogItems, Date, DateTime, Integer, Double, Boolean, DateTimeInterval, Hyperlink.
Возвращает строку, содержащую URL-ссылку на форму редактирования.

Ссылка на форму добавления в мобильном приложении

api.web.add(fqn, mobileForm, parent, attributes, needCheckAttrs)

api.web.add(fqns, mobileForm, parent, attributes)

Генерирует URL-ссылку для перехода на форму добавления объекта указанного типа /класса.

Если указаны parent и attributes, то формирует ссылку для перехода на форму добавления объекта без проверок на существование заданных атрибутов в классе/типе и корректности их значений.

Если указано needCheckAttrs, то формирует URL-ссылку на форму добавления объекта указанного типа /класса с предзаполненными полями с проверкой на существование заданных атрибутов в классе/типе и корректности их значений.

При переходе по ссылке требуется указывать логин и пароль, также может использоваться прозрачная аутентификация (Kerberos).

Параметры метода:
- fqns — коллекция fqn'ов доступных для выбора типов добавляемого объекта. Допускается указывать только типы объектов одного класса. Значение fqn может быть как объект ClassFqn, так и его строковый эквивалент.
- fqn — класс (тип), форма добавления которого открывается при переходе по ссылке. Значение fqn может быть как объект ClassFqn, так и его строковый эквивалент
  
  Если параметр fqn указывает на тип, то при переходе по ссылке будет открыта форма добавления этого типа, контент "Тип объекта" на форме не отобразится, если на класс – будет открыта форма добавления класса с возможностью выбора любого доступного пользователю типа этого класса.
  
  Если ассоциативный массив, заданный в параметре attributes не пуст, соответствующие поля формы при ее открытии будут заполнены указанными значениями.
- mobileForm — код формы добавления в мобильном приложении. Может быть null.
  
  Если mobileForm указан, то при переходе по ссылке в мобильном приложении будет открыта указанная форма добавления
- parent — в зависимости от класса, на который указывает fqn, параметр рассматривается как:
  - контрагент запроса, если fqn задает класс "Запрос" (serviceCall).
  - родительский объект, если fqn задает класс вложенных объектов.
  Если fqn указывает на классы, не перечисленные выше, то данный параметр заполняется значением null или пустой строкой.
  
  Параметр может быть задан в виде объекта или строки, содержащей его UUID.
- attributes — ассоциативный массив, содержащий значения по умолчанию для атрибутов создаваемого объекта: ключ — код атрибута; значение — значение по умолчанию атрибута
  
  Доступные типы атрибутов: BOLinks, BOLink, BackLink, CatalogItems, Date, DateTime, Integer, Double, Boolean, DateTimeInterval, Hyperlink.
- needCheckAttrs — признак, определяющий требуются ли проверки на существование заданных атрибутов в классе/типе и корректности их значений
Возвращает строку, содержащую URL-ссылку на форму добавления объекта указанного типа (класса).

Генерация ссылки на форму авторизации

api.web.signIn(employee)

Формирование ссылки на форму авторизации с заполненным логином.

Параметр метода:
- employee — объект, UUID или логин пользователя.
Возвращает строку со ссылкой для открытия формы авторизации.

Примеры:

1. Генерация ссылки на форму авторизации с заполненным логином, в аргумент передается логин пользователя:

api.web.signIn('user')

Результат: http://localhost:8080/sd/?smp_login=user.

2. Генерация ссылки на форму авторизации с заполненным логином, в аргумент передается UUID пользователя:

api.web.signIn('employee$6001')

Результат: http://localhost:8080/sd/?smp_login=testlogin.

3. Генерация ссылки на форму авторизации с заполненным логином, в аргумент передается объект пользователя:

api.web.signIn(utils.get('employee$6001'))

Результат: http://localhost:8080/sd/?smp_login=testlogin.

Любая ссылка, содержащая параметр smp_login, открывается после перехода в указанный аккаунт.