Hierarchy

  • TFolder

Properties

Optional __deletedAt

__deletedAt: TDatetime

Дата и время удаления.

id

id: string

Идентификатор папки.

level

level: number

Уровень вложенности папки внутри приложения.

name

name: string

Название папки.

Methods

createFolder

  • createFolder(name: string): Promise<TFolder>
  • Метод создаёт новую дочернюю папку.

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

    const folder = await Context.data.item?.getFolder();
    const childFolder = await folder.createFolder('name');
    

    Parameters

    • name: string

      Имя создаваемой папки.

    Returns Promise<TFolder>

getChildren

  • getChildren(): Promise<TFolder[]>
  • Метод получает массив дочерних папок.

    В примере с помощью метода мы получаем все папки второго уровня вложенности. Они являются дочерними по отношению к папкам на уровне приложения.

    const folders = await Application.getFolders();
    const allChildren: TFolder[] = [];
    folders.forEach(folder => {
        const children = await folder.getChildren();
        allChildren.push(...children);
    });
    

    Returns Promise<TFolder[]>

    Дочерние папки.

getParent

  • getParent(): Promise<TFolder | undefined>
  • Метод получает родительскую папку.

    В примере с помощью метода мы получаем родительскую папку элемента приложения.

    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>

    Права доступа, установленные для данной папки.

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>