ПолучитьСписокДокументов

Последние изменение: 28.08.2019

Событие о запросе получения списка документов с сервера. Вызывается при открытии списка документов на терминале и периодически при нахождении внутри списка. Позволяет реализовать поиск и отбор документов по параметрам непосредственно в базе учетной системы, без предварительной выгрузки.

Вызов события может происходить только в том случае, если включен режим отображения серверных документов в списке документов терминала.

Если в панели управления в типах документов «Показывать в списке документы на сервере» проставлено «Нет», то никакого события на сервере не происходит. В случае, когда проставлено «Да», то терминал по необходимости будет запрашивать документы с сервера, заодно вызывая событие получения списка.

Параметры

Имя параметра Тип данных Описание
ИдПользователя string (строка) Идентификатор пользователя Mobile SMARTS, при работе которого на ТСД, произошел вызов обработчика. 
ТипДокумента string (строка) Тип документов, которые запрашиваются с терминала. Если тип документа null (неопределено) или пустая строка – запрашиваются все документы, вне зависимости от их типа.
XmlСессии string (строка) Объект сессии сервера Mobile SMARTS, сериализованный в xml. Параметр передается, только если включена настройка «Добавлять объект сессии в вызов событий»

Возвращаемое значение

В качестве возвращаемого значения ожидается коллекция описаний документов Cleverence.Warehouse.DocumentDescriptionCollection, сохраненная в виде XML.

Событие может быть обработано модулем «Вызов серверных операций», в этом случае в серверную операцию в параметр Result передается результат вызова предыдущего  обработчика в цепочке обработчиков данного события (если задано несколько обработчиков). Результат также возвращается в переменной Result. Серверная операция может изменить полученный из внешней системы список документов или вернуть свой собственный.

Описание в панели управления:

C#
<ид. коннектора>:ПолучитьСписокДокументов

Ид. коннектора - задается в панели управления.

Например: OneC_Connector:ПолучитьСписокДокументов

Пример функции

Для «1С:Предприятия 8»:

C#
Функция ПолучитьСписокДокументов(UserId, ТипДокумента, mXmlDoc = Неопределено) Экспорт StorageConnector = Новый COMObject("Cleverence.Warehouse.StorageConnector"); ДокументыТСД = Новый COMObject("Cleverence.Warehouse.DocumentDescriptionCollection"); ОтобранныеДокументы = ОтобратьДокументы(UserId, ТипДокумента); Для Каждого СтрокаДок из ОтобранныеДокументы Цикл DocDescr = Новый COMОбъект("Cleverence.Warehouse.DocumentDescription"); DocDescr.Id = XMLСтрока(СтрокаДок.Ссылка); cDescr.Name = Строка(СтрокаДок.Ссылка); DocDescr.DocumentTypeName = ТипДокумента; DocDescrs.Add(DocDescr); КонецЦикла; Результат = StorageConnector.ToXml(DocDescrs); Возврат Результат; КонецФункции