@pnp/spfx-controls-react/lib/services/IFolderExplorerService.d.ts

Reusable React controls for SharePoint Framework solutions

import { IFileInfo } from "@pnp/sp/files";
export interface IFolder {
    /**
     * Folder name
     */
    Name: string;
    /**
     * Server relative url of the folder
     */
    ServerRelativeUrl: string;
}
export interface IFolderExplorerService {
    /**
   * Get libraries within a given site
   * @param webAbsoluteUrl - the url of the target site
   */
    GetDocumentLibraries(webAbsoluteUrl: string): Promise<IFolder[]>;
    /**
    * Get folders within a given library or sub folder
    * @param webAbsoluteUrl - the url of the target site
    * @param folderRelativeUrl - the relative url of the folder
    */
    GetFolders(webAbsoluteUrl: string, folderRelativeUrl: string, orderby: string, orderAscending: boolean): Promise<IFolder[]>;
    /**
    * Get files within a given library or sub folder
    * @param webAbsoluteUrl - the url of the target site
    * @param folderRelativeUrl - the relative url of the folder
    */
    GetFiles(webAbsoluteUrl: string, folderRelativeUrl: string, orderby: string, orderAscending: boolean): Promise<IFileInfo[]>;
    /**
    * Create a new folder
    * @param webAbsoluteUrl - the url of the target site
    * @param folderRelativeUrl - the relative url of the base folder
    * @param name - the name of the folder to be created
    */
    AddFolder(webAbsoluteUrl: string, folderRelativeUrl: string, name: string): Promise<IFolder>;
}
//# sourceMappingURL=IFolderExplorerService.d.ts.map