Hierarchy
- TFolder
Properties
Optional __deletedAt
Дата и время удаления.
id
Идентификатор папки.
level
Уровень вложенности папки внутри приложения.
name
Название папки.
Methods
createFolder
-
Метод создаёт новую дочернюю папку.
В примере с помощью метода мы получаем папку элемента приложения и создаём внутри неё новую папку.
const folder = await Context.data.item?.getFolder(); const childFolder = await folder.createFolder('name');
Parameters
-
name: string
Имя создаваемой папки.
Returns Promise<TFolder>
-
getChildren
-
Метод получает массив дочерних папок.
В примере с помощью метода мы получаем все папки второго уровня вложенности. Они являются дочерними по отношению к папкам на уровне приложения.
const folders = await Application.getFolders(); const allChildren: TFolder[] = []; folders.forEach(folder => { const children = await folder.getChildren(); allChildren.push(...children); });
Returns Promise<TFolder[]>
Дочерние папки.
getParent
-
Метод получает родительскую папку.
В примере с помощью метода мы получаем родительскую папку элемента приложения.
const folder = await Context.data.item?.getFolder(); const parentFolder = await folder.getParent();
Returns Promise<TFolder | undefined>
Родительская папка или
undefined
, если папка находится на высшем уровне.
getPermissions
-
Получает права доступа, установленные для данной папки.
Метод следует использовать, если нужно добавить новые права доступа к существующим.
В примере с помощью метода мы получаем установленные для папки права и добавляем права на обновление инициатору процесса.
const folder = await Context.data.item?.getFolder(); const user = Context.data.__createdBy; if (folder) { const currPermissions = await folder.getPermissions() currPermissions.values.push(new PermissionValue(user, [PermissionType.UPDATE])) await folder.setPermissions(currPermissions); }
Returns Promise<TPermissions>
Права доступа, установленные для данной папки.
setName
-
Метод позволяет изменить имя папки.
Пример использования:
const folders = await Application.getFolders(); if (folders.length !== 0) { const folder = folders[0]; await folder.setName('NEW_NAME'); }
Parameters
-
name: string
Returns Promise<void>
-
setPermissions
-
Метод устанавливает новые права на папку.
Метод полностью заменяет существующие права новыми.
В примере с помощью метода мы устанавливаем для папки новые права инициатору процесса.
const folder = await Context.data.item?.getFolder(); const user = Context.data.executor; if (folder) { const permissions = new Permissions([new PermissionValue(user, [PermissionType.DELETE, PermissionType.UPDATE])]); await folder.setPermissions(permissions); }
Parameters
-
permissions: TPermissions
Права доступа, которые будут установлены для папки.
Returns Promise<void>
-
Папка внутри приложения