ithit.webdav.server/Class1/IFolder.d.ts

With IT Hit WebDAV Server Engine for Node.js you can create your own WebDAV server, add WebDAV support to your existing Node.js project or DAV-enable your CMS/DMS/CRM.

/**
 * @copyright Copyright (c) 2017 IT Hit. All rights reserved.
 */
import { IItemCollection } from "../IItemCollection";
import { IHierarchyItem } from "../IHierarchyItem";
/**
 * Represents a folder in the WebDAV repository.
 * @remarks
 * Defines the properties and methods that WebDAV server folder objects must implement.
 * In addition to methods and properties provided by {@link IHierarchyItem}  and {@link IItemCollection}  this interface also provides
 * methods for creating WebDAV items (folders and files).
 */
export interface IFolder extends IItemCollection {
    /**
     * Creates new WebDAV file with the specified name in this folder.
     * @param name Name of the file to create.
     * @exception LockedException This folder was locked. Client did not provide the lock token.
     * @exception NeedPrivilegesException The user doesn't have enough privileges.
     * @exception InsufficientStorageException Quota limit is reached.
     * @exception DavException In other cases.
     * @remarks You must create a file in your repository during this call.
     * After calling this method Engine calls {@link IContent.write}.
     */
    createFile(name: string): Promise<IHierarchyItem | null>;
    /**
     * Creates new WebDAV folder with the specified name in this folder.
     * @param name Name of the folder to create.
     * @exception LockedException This folder was locked. Client did not provide the lock token.
     * @exception NeedPrivilegesException The user doesn't have enough privileges.
     * @exception InsufficientStorageException Quota limit is reached.
     * @exception DavException In other cases.
     */
    createFolder(name: string): void;
}