Show / Hide Table of Contents

Class FolderManager

Inheritance
object
ComponentBase<IFolderManager, FolderManager>
FolderManager
Implements
IFolderManager
Inherited Members
ComponentBase<IFolderManager, FolderManager>.RegisterInstance(IFolderManager)
ComponentBase<IFolderManager, FolderManager>.Instance
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: DotNetNuke.Services.FileSystem
Assembly: DotNetNuke.dll
Syntax
public class FolderManager : ComponentBase<IFolderManager, FolderManager>, IFolderManager

Constructors

FolderManager()

Declaration
public FolderManager()

Properties

MyFolderName

Declaration
public virtual string MyFolderName { get; }
Property Value
Type Description
string

Methods

AddAllUserReadPermission(IFolderInfo, PermissionInfo)

Declaration
public virtual void AddAllUserReadPermission(IFolderInfo folder, PermissionInfo permission)
Parameters
Type Name Description
IFolderInfo folder
PermissionInfo permission

AddFolder(FolderMappingInfo, string)

Declaration
public virtual IFolderInfo AddFolder(FolderMappingInfo folderMapping, string folderPath)
Parameters
Type Name Description
FolderMappingInfo folderMapping
string folderPath
Returns
Type Description
IFolderInfo

AddFolder(FolderMappingInfo, string, string)

Declaration
public virtual IFolderInfo AddFolder(FolderMappingInfo folderMapping, string folderPath, string mappedPath)
Parameters
Type Name Description
FolderMappingInfo folderMapping
string folderPath
string mappedPath
Returns
Type Description
IFolderInfo

AddFolder(int, string)

Declaration
public virtual IFolderInfo AddFolder(int portalId, string folderPath)
Parameters
Type Name Description
int portalId
string folderPath
Returns
Type Description
IFolderInfo

CopyParentFolderPermissions(IFolderInfo)

Declaration
public virtual void CopyParentFolderPermissions(IFolderInfo folder)
Parameters
Type Name Description
IFolderInfo folder

DeleteFolder(IFolderInfo)

Declaration
public virtual void DeleteFolder(IFolderInfo folder)
Parameters
Type Name Description
IFolderInfo folder

DeleteFolder(IFolderInfo, ICollection<IFolderInfo>)

Declaration
public void DeleteFolder(IFolderInfo folder, ICollection<IFolderInfo> notDeletedSubfolders)
Parameters
Type Name Description
IFolderInfo folder
ICollection<IFolderInfo> notDeletedSubfolders

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
Type Description
bool

GetFileSystemFolders(UserInfo, string)

Declaration
public virtual IEnumerable<IFolderInfo> GetFileSystemFolders(UserInfo user, string permissions)
Parameters
Type Name Description
UserInfo user
string permissions
Returns
Type Description
IEnumerable<IFolderInfo>

GetFiles(IFolderInfo)

Declaration
public virtual IEnumerable<IFileInfo> GetFiles(IFolderInfo folder)
Parameters
Type Name Description
IFolderInfo folder
Returns
Type Description
IEnumerable<IFileInfo>

GetFiles(IFolderInfo, bool)

Declaration
public virtual IEnumerable<IFileInfo> GetFiles(IFolderInfo folder, bool recursive)
Parameters
Type Name Description
IFolderInfo folder
bool recursive
Returns
Type Description
IEnumerable<IFileInfo>

GetFiles(IFolderInfo, bool, bool)

Declaration
public virtual IEnumerable<IFileInfo> GetFiles(IFolderInfo folder, bool recursive, bool retrieveUnpublishedFiles)
Parameters
Type Name Description
IFolderInfo folder
bool recursive
bool retrieveUnpublishedFiles
Returns
Type Description
IEnumerable<IFileInfo>

GetFolder(Guid)

Declaration
public virtual IFolderInfo GetFolder(Guid uniqueId)
Parameters
Type Name Description
Guid uniqueId
Returns
Type Description
IFolderInfo

GetFolder(int)

Declaration
public virtual IFolderInfo GetFolder(int folderId)
Parameters
Type Name Description
int folderId
Returns
Type Description
IFolderInfo

GetFolder(int, string)

Declaration
public virtual IFolderInfo GetFolder(int portalId, string folderPath)
Parameters
Type Name Description
int portalId
string folderPath
Returns
Type Description
IFolderInfo

GetFolders(UserInfo)

Declaration
public virtual IEnumerable<IFolderInfo> GetFolders(UserInfo user)
Parameters
Type Name Description
UserInfo user
Returns
Type Description
IEnumerable<IFolderInfo>

GetFolders(UserInfo, string)

Declaration
public virtual IEnumerable<IFolderInfo> GetFolders(UserInfo user, string permissions)
Parameters
Type Name Description
UserInfo user
string permissions
Returns
Type Description
IEnumerable<IFolderInfo>

GetFolders(IFolderInfo)

Declaration
public virtual IEnumerable<IFolderInfo> GetFolders(IFolderInfo parentFolder)
Parameters
Type Name Description
IFolderInfo parentFolder
Returns
Type Description
IEnumerable<IFolderInfo>

GetFolders(int)

Declaration
public virtual IEnumerable<IFolderInfo> GetFolders(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
IEnumerable<IFolderInfo>

GetFolders(int, bool)

Declaration
public virtual IEnumerable<IFolderInfo> GetFolders(int portalId, bool useCache)
Parameters
Type Name Description
int portalId
bool useCache
Returns
Type Description
IEnumerable<IFolderInfo>

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
Type Description
IEnumerable<IFolderInfo>

GetUserFolder(UserInfo)

Declaration
public virtual IFolderInfo GetUserFolder(UserInfo userInfo)
Parameters
Type Name Description
UserInfo userInfo
Returns
Type Description
IFolderInfo

MoveFolder(IFolderInfo, IFolderInfo)

Declaration
public virtual IFolderInfo MoveFolder(IFolderInfo folder, IFolderInfo destinationFolder)
Parameters
Type Name Description
IFolderInfo folder
IFolderInfo destinationFolder
Returns
Type Description
IFolderInfo

RenameFolder(IFolderInfo, string)

Declaration
public virtual void RenameFolder(IFolderInfo folder, string newFolderName)
Parameters
Type Name Description
IFolderInfo folder
string newFolderName

SearchFiles(IFolderInfo, string, bool)

Declaration
public virtual IEnumerable<IFileInfo> SearchFiles(IFolderInfo folder, string pattern, bool recursive)
Parameters
Type Name Description
IFolderInfo folder
string pattern
bool recursive
Returns
Type Description
IEnumerable<IFileInfo>

SetFolderPermission(IFolderInfo, int, int)

Declaration
public virtual void SetFolderPermission(IFolderInfo folder, int permissionId, int roleId)
Parameters
Type Name Description
IFolderInfo folder
int permissionId
int roleId

SetFolderPermission(IFolderInfo, int, int, int)

Declaration
public virtual void SetFolderPermission(IFolderInfo folder, int permissionId, int roleId, int userId)
Parameters
Type Name Description
IFolderInfo folder
int permissionId
int roleId
int userId

SetFolderPermissions(IFolderInfo, int)

Declaration
public virtual void SetFolderPermissions(IFolderInfo folder, int administratorRoleId)
Parameters
Type Name Description
IFolderInfo folder
int administratorRoleId

Synchronize(int)

Declaration
public virtual int Synchronize(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
int

Synchronize(int, string)

Declaration
public virtual int Synchronize(int portalId, string relativePath)
Parameters
Type Name Description
int portalId
string relativePath
Returns
Type Description
int

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
Type Description
int

UnlinkFolder(IFolderInfo)

Declaration
public virtual void UnlinkFolder(IFolderInfo folder)
Parameters
Type Name Description
IFolderInfo folder

UpdateFolder(IFolderInfo)

Declaration
public virtual IFolderInfo UpdateFolder(IFolderInfo folder)
Parameters
Type Name Description
IFolderInfo folder
Returns
Type Description
IFolderInfo

Implements

IFolderManager

Extension Methods

JsonExtensionsWeb.ToJson(object)
Back to top by the community, for the community... #DNNCMS