Class FolderManager
  
  
  
    Inheritance
    
    
    FolderManager
   
  
  
  
  Assembly: DotNetNuke.dll
  Syntax
  
    public class FolderManager : ComponentBase<IFolderManager, FolderManager>, IFolderManager
   
  Constructors
  
  FolderManager()
  
  
  Declaration
  
  Properties
  
  MyFolderName
  
  
  Declaration
  
    public virtual string MyFolderName { get; }
   
  Property Value
  
  Methods
  
  AddAllUserReadPermission(IFolderInfo, PermissionInfo)
  
  
  Declaration
  
    public virtual void AddAllUserReadPermission(IFolderInfo folder, PermissionInfo permission)
   
  Parameters
  
  
  AddFolder(FolderMappingInfo, string)
  
  
  Declaration
  
    public virtual IFolderInfo AddFolder(FolderMappingInfo folderMapping, string folderPath)
   
  Parameters
  
  Returns
  
  
  AddFolder(FolderMappingInfo, string, string)
  
  
  Declaration
  
    public virtual IFolderInfo AddFolder(FolderMappingInfo folderMapping, string folderPath, string mappedPath)
   
  Parameters
  
  Returns
  
  
  AddFolder(int, string)
  
  
  Declaration
  
    public virtual IFolderInfo AddFolder(int portalId, string folderPath)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | portalId |  | 
      
        | string | folderPath |  | 
    
  
  Returns
  
  
  CopyParentFolderPermissions(IFolderInfo)
  
  
  Declaration
  
    public virtual void CopyParentFolderPermissions(IFolderInfo folder)
   
  Parameters
  
  
  DeleteFolder(IFolderInfo)
  
  
  Declaration
  
    public virtual void DeleteFolder(IFolderInfo folder)
   
  Parameters
  
  
  DeleteFolder(IFolderInfo, ICollection<IFolderInfo>)
  
  
  Declaration
  
    public void DeleteFolder(IFolderInfo folder, ICollection<IFolderInfo> notDeletedSubfolders)
   
  Parameters
  
  
  DeleteFolder(int)
  
  
  Declaration
  
    public virtual void DeleteFolder(int folderId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | folderId |  | 
    
  
  
  FolderExists(int, string)
  
  
  Declaration
  
    public virtual bool FolderExists(int portalId, string folderPath)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | portalId |  | 
      
        | string | folderPath |  | 
    
  
  Returns
  
  
  GetFileSystemFolders(UserInfo, string)
  
  
  Declaration
  
    public virtual IEnumerable<IFolderInfo> GetFileSystemFolders(UserInfo user, string permissions)
   
  Parameters
  
  Returns
  
  
  GetFiles(IFolderInfo)
  
  
  Declaration
  
    public virtual IEnumerable<IFileInfo> GetFiles(IFolderInfo folder)
   
  Parameters
  
  Returns
  
  
  GetFiles(IFolderInfo, bool)
  
  
  Declaration
  
    public virtual IEnumerable<IFileInfo> GetFiles(IFolderInfo folder, bool recursive)
   
  Parameters
  
  Returns
  
  
  GetFiles(IFolderInfo, bool, bool)
  
  
  Declaration
  
    public virtual IEnumerable<IFileInfo> GetFiles(IFolderInfo folder, bool recursive, bool retrieveUnpublishedFiles)
   
  Parameters
  
  Returns
  
  
  GetFolder(Guid)
  
  
  Declaration
  
    public virtual IFolderInfo GetFolder(Guid uniqueId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | Guid | uniqueId |  | 
    
  
  Returns
  
  
  GetFolder(int)
  
  
  Declaration
  
    public virtual IFolderInfo GetFolder(int folderId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | folderId |  | 
    
  
  Returns
  
  
  GetFolder(int, string)
  
  
  Declaration
  
    public virtual IFolderInfo GetFolder(int portalId, string folderPath)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | portalId |  | 
      
        | string | folderPath |  | 
    
  
  Returns
  
  
  GetFolders(UserInfo)
  
  
  Declaration
  
    public virtual IEnumerable<IFolderInfo> GetFolders(UserInfo user)
   
  Parameters
  
  Returns
  
  
  GetFolders(UserInfo, string)
  
  
  Declaration
  
    public virtual IEnumerable<IFolderInfo> GetFolders(UserInfo user, string permissions)
   
  Parameters
  
  Returns
  
  
  GetFolders(IFolderInfo)
  
  
  Declaration
  
    public virtual IEnumerable<IFolderInfo> GetFolders(IFolderInfo parentFolder)
   
  Parameters
  
  Returns
  
  
  GetFolders(int)
  
  
  Declaration
  
    public virtual IEnumerable<IFolderInfo> GetFolders(int portalId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | portalId |  | 
    
  
  Returns
  
  
  GetFolders(int, bool)
  
  
  Declaration
  
    public virtual IEnumerable<IFolderInfo> GetFolders(int portalId, bool useCache)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | portalId |  | 
      
        | bool | useCache |  | 
    
  
  Returns
  
  
  GetFolders(int, string, int)
  
  
  Declaration
  
    public virtual IEnumerable<IFolderInfo> GetFolders(int portalId, string permissions, int userId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | portalId |  | 
      
        | string | permissions |  | 
      
        | int | userId |  | 
    
  
  Returns
  
  
  GetUserFolder(UserInfo)
  
  
  Declaration
  
    public virtual IFolderInfo GetUserFolder(UserInfo userInfo)
   
  Parameters
  
  Returns
  
  
  MoveFolder(IFolderInfo, IFolderInfo)
  
  
  Declaration
  
    public virtual IFolderInfo MoveFolder(IFolderInfo folder, IFolderInfo destinationFolder)
   
  Parameters
  
  Returns
  
  
  RenameFolder(IFolderInfo, string)
  
  
  Declaration
  
    public virtual void RenameFolder(IFolderInfo folder, string newFolderName)
   
  Parameters
  
  
  SearchFiles(IFolderInfo, string, bool)
  
  
  Declaration
  
    public virtual IEnumerable<IFileInfo> SearchFiles(IFolderInfo folder, string pattern, bool recursive)
   
  Parameters
  
  Returns
  
  
  SetFolderPermission(IFolderInfo, int, int)
  
  
  Declaration
  
    public virtual void SetFolderPermission(IFolderInfo folder, int permissionId, int roleId)
   
  Parameters
  
  
  SetFolderPermission(IFolderInfo, int, int, int)
  
  
  Declaration
  
    public virtual void SetFolderPermission(IFolderInfo folder, int permissionId, int roleId, int userId)
   
  Parameters
  
  
  SetFolderPermissions(IFolderInfo, int)
  
  
  Declaration
  
    public virtual void SetFolderPermissions(IFolderInfo folder, int administratorRoleId)
   
  Parameters
  
  
  Synchronize(int)
  
  
  Declaration
  
    public virtual int Synchronize(int portalId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | portalId |  | 
    
  
  Returns
  
  
  Synchronize(int, string)
  
  
  Declaration
  
    public virtual int Synchronize(int portalId, string relativePath)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | portalId |  | 
      
        | string | relativePath |  | 
    
  
  Returns
  
  
  Synchronize(int, string, bool, bool)
  
  
  Declaration
  
    public virtual int Synchronize(int portalId, string relativePath, bool isRecursive, bool syncFiles)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | portalId |  | 
      
        | string | relativePath |  | 
      
        | bool | isRecursive |  | 
      
        | bool | syncFiles |  | 
    
  
  Returns
  
  
  UnlinkFolder(IFolderInfo)
  
  
  Declaration
  
    public virtual void UnlinkFolder(IFolderInfo folder)
   
  Parameters
  
  
  UpdateFolder(IFolderInfo)
  
  
  Declaration
  
    public virtual IFolderInfo UpdateFolder(IFolderInfo folder)
   
  Parameters
  
  Returns
  
  Implements
  
  Extension Methods