Hierarchy
- DocflowApplicationItemRef
Methods
changeRegistration
-
Метод изменяет регистрационный номер элемента приложения после регистрации.
Пример изменения регистрационного номера в первом зарегистрированном деле элемента приложения типа Документ:
const item = Context.data.d1! const registrations = await item.docflow().getRegistrations() if (registrations.length <= 0) { throw new Error('something gone wrong'); } await item.docflow().changeRegistration(registrations[0].nomenclatureId, "number1");
Parameters
-
nomenclatureId: string
номер дела.
-
numberRegistration: string
новый номер регистрации.
Returns Promise<void>
-
deleteRegistration
-
Метод удаляет регистрацию элемента приложения.
Пример удаления регистрации во всех делах для элемента приложения типа Документ:
const item = Context.data.d1! const settings = await Application.getSettings(); settings.registrationSettings.nomenclatureIds.forEach(nomenclatureId => { item.docflow().deleteRegistration(nomenclatureId); })
Parameters
-
nomenclatureId: string
Номер дела.
Returns Promise<boolean>
Результат удаления.
-
deleteReservation
-
Метод отменяет резервирование номера в определённом деле для элемента приложения типа Документ.
Пример отмены резервирования номера для элемента приложения:
const item = Context.data.d1! const settings = await Application.getSettings(); const nomenclatures = []; for (const nomenclatureId of settings.registrationSettings.nomenclatureIds) { const nomenclature = await item.docflow().getNomenclature(nomenclatureId); if (nomenclature !== undefined) { nomenclatures.push(nomenclature); } } const nomenclatureName = 'Название дела' const nomenclatureForReservation = nomenclatures.find(nom => nom.name === nomenclatureName); if (nomenclatureForReservation !== undefined) { await item.docflow().deleteReservation(nomenclatureForReservation.__id); }
Parameters
-
nomenclatureId: string
Номер дела.
Returns Promise<void>
-
getApprovalArchivedLists
-
Метод загружает листы согласования, находящиеся в архиве.
const item = await Context.data.n1; const approvalLists = await item.docflow().getApprovalArchivedLists();
Returns Promise<BaseList[]>
Листы согласования в архиве.
getApprovalLists
-
Метод загружает активные листы согласования.
const item = await Context.data.n1; const approvalLists = await item.docflow().getApprovalLists();
Returns Promise<BaseList[]>
Активные листы согласования.
getInformArchivedLists
-
Метод загружает листы ознакомления, находящиеся в архиве.
const item = await Context.data.n1; const approvalLists = await item.docflow().getInformArchivedLists();
Returns Promise<BaseList[]>
Листы ознакомления в архиве.
getInformLists
-
Метод загружает активные листы ознакомления.
const item = await Context.data.n1; const approvalLists = await item.docflow().getInformLists();
Returns Promise<BaseList[]>
Активные листы ознакомления.
getNomenclature
-
Метод получает дело по номеру.
Пример получения дела, в котором зарегистрирован элемент приложения типа Документ:
const item = Context.data.d1! const settings = await Application.getSettings(); const nomenclatures = []; for (const nomenclatureId of settings.registrationSettings.nomenclatureIds) { const nomenclature = await item.docflow().getNomenclature(nomenclatureId); if (nomenclature !== undefined) { nomenclatures.push(nomenclature); } }
Parameters
-
nomenclatureId: string
Номер дела.
Returns Promise<TNomenclature | undefined>
Дело, если найдено.
-
getRegistrations
-
Метод получает список регистраций элемента приложения типа Документ.
const item = Context.data.d1! await item.docflow().getRegistrations();
Returns Promise<ApplicationItemRegistration[]>
Список регистраций элемента приложения.
getReserved
-
Метод получает номер, который был зарезервирован ранее для элемента приложения типа Документ в определённом деле.
Пример получения зарезервированного номера для элемента приложения:
const item = Context.data.d1 if (item) { const settings = await Application.getSettings() const nomenclatures: TNomenclature[] = []; for (const nomenclatureId of settings.registrationSettings.nomenclatureIds) { const nomenclature = await item.docflow().getNomenclature(nomenclatureId) if (nomenclature !== undefined) { nomenclatures.push(nomenclature) } } const nomenclatureName = 'Название дела' const nomenclatureForReservation = nomenclatures.find(nom => nom.__name === nomenclatureName) if (nomenclatureForReservation !== undefined) { const reservedNumber = await item.docflow().getReserved(nomenclatureForReservation.__id) Context.data.reservedNumber = reservedNumber } }
Parameters
-
nomenclatureId: string
Номер дела.
Returns Promise<string>
Зарезервированный номер.
-
manualRegister
-
Метод вручную регистрирует элемент приложения типа Документ.
Для использования метода должна быть включена ручная регистрация в настройках дела.
При отсутствии параметра
dateRegistry
для регистрации будет задана текущая дата.Пример ручной регистрации всех элементов приложения в делах, доступных для приложения:
const item = Context.data.d1! const settings = await Application.getSettings(); settings.registrationSettings.nomenclatureIds.forEach(nomenclatureId => { item.docflow().manualRegister("Номер тест 1", nomenclatureId, new Datetime('2021-01-20')); })
Parameters
-
nameReg: string
Номер регистрации.
-
nomenclatureId: string
Номер дела.
-
Optional dateRegistry: TDatetime
Дата регистрации (необязательный параметр).
Returns Promise<boolean>
Результат регистрации.
-
register
-
Метод автоматически регистрирует элемент приложения типа Документ.
Номер регистрации будет сформирован автоматически в соответствии с шаблоном, установленным для дела.
Пример автоматической регистрации во всех доступных для приложения делах:
const item = Context.data.d1! const settings = await Application.getSettings(); settings.registrationSettings.nomenclatureIds.forEach(nomenclatureId => { item.docflow().register(nomenclatureId); })
Parameters
-
nomenclatureId: string
Номер дела.
Returns Promise<boolean>
Результат регистрации.
-
reserve
-
Метод резервирует номер для элемента приложения типа Документ в определённом деле.
Номер формируется автоматически в соответствии с шаблоном, установленным для дела.
Пример резервирования номера для элемента приложения в определённом деле:
const item = Context.data.d1! const settings = await Application.getSettings(); const nomenclatures = []; for (const nomenclatureId of settings.registrationSettings.nomenclatureIds) { const nomenclature = await item.docflow().getNomenclature(nomenclatureId); if (nomenclature !== undefined) { nomenclatures.push(nomenclature); } } const nomenclatureName = 'Название дела'; const nomenclatureForReservation = nomenclatures.find(nom => nom.name === nomenclatureName); if (nomenclatureForReservation !== undefined) { const reservedNumber = await item.docflow().reserve(nomenclatureForReservation.__id); }
Parameters
-
nomenclatureId: string
Номер дела.
Returns Promise<string>
Зарезервированный номер.
-
unarchiveApprovalList
-
Метод переводит лист согласования из архива в активный статус.
Пример возвращения всех листов из архива:
const item = await Context.data.n1; const approvalLists = await item.docflow().getApprovalArchivedLists(); approvalLists.forEach(list => item.docflow().unarchiveApprovalList(list.__id))
Parameters
-
listId: string
Номер листа.
Returns Promise<void>
-
Объект для работы с регистрациями и листами элемента