Interface IFolderManager

Namespace: DotNetNuke.Services.FileSystem

Assembly: DotNetNuke.dll

Syntax

public interface IFolderManager

Properties

MyFolderName

Declaration

string MyFolderName { get; }

Property Value

Type	Description
string

Methods

AddAllUserReadPermission(IFolderInfo, PermissionInfo)

Declaration

void AddAllUserReadPermission(IFolderInfo folder, PermissionInfo permission)

Parameters

Type	Name	Description
IFolderInfo	folder
PermissionInfo	permission

AddFolder(FolderMappingInfo, string)

Declaration

IFolderInfo AddFolder(FolderMappingInfo folderMapping, string folderPath)

Parameters

Type	Name	Description
FolderMappingInfo	folderMapping
string	folderPath

Returns

Type	Description
IFolderInfo

AddFolder(FolderMappingInfo, string, string)

Declaration

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

IFolderInfo AddFolder(int portalId, string folderPath)

Parameters

Type	Name	Description
int	portalId
string	folderPath

Returns

Type	Description
IFolderInfo

CopyParentFolderPermissions(IFolderInfo)

Declaration

void CopyParentFolderPermissions(IFolderInfo folder)

Parameters

Type	Name	Description
IFolderInfo	folder

DeleteFolder(IFolderInfo)

Declaration

void DeleteFolder(IFolderInfo folder)

Parameters

Type	Name	Description
IFolderInfo	folder

DeleteFolder(IFolderInfo, ICollection<IFolderInfo>)

Declaration

void DeleteFolder(IFolderInfo folder, ICollection<IFolderInfo> notDeletedSubfolders)

Parameters

Type	Name	Description
IFolderInfo	folder
ICollection<IFolderInfo>	notDeletedSubfolders

DeleteFolder(int)

Declaration

void DeleteFolder(int folderId)

Parameters

Type	Name	Description
int	folderId

FolderExists(int, string)

Declaration

bool FolderExists(int portalId, string folderPath)

Parameters

Type	Name	Description
int	portalId
string	folderPath

Returns

Type	Description
bool

GetFileSystemFolders(UserInfo, string)

Declaration

IEnumerable<IFolderInfo> GetFileSystemFolders(UserInfo user, string permissions)

Parameters

Type	Name	Description
UserInfo	user
string	permissions

Returns

Type	Description
IEnumerable<IFolderInfo>

GetFiles(IFolderInfo)

Declaration

IEnumerable<IFileInfo> GetFiles(IFolderInfo folder)

Parameters

Type	Name	Description
IFolderInfo	folder

Returns

Type	Description
IEnumerable<IFileInfo>

GetFiles(IFolderInfo, bool)

Declaration

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

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

IFolderInfo GetFolder(Guid uniqueId)

Parameters

Type	Name	Description
Guid	uniqueId

Returns

Type	Description
IFolderInfo

GetFolder(int)

Declaration

IFolderInfo GetFolder(int folderId)

Parameters

Type	Name	Description
int	folderId

Returns

Type	Description
IFolderInfo

GetFolder(int, string)

Declaration

IFolderInfo GetFolder(int portalId, string folderPath)

Parameters

Type	Name	Description
int	portalId
string	folderPath

Returns

Type	Description
IFolderInfo

GetFolders(UserInfo)

Declaration

IEnumerable<IFolderInfo> GetFolders(UserInfo user)

Parameters

Type	Name	Description
UserInfo	user

Returns

Type	Description
IEnumerable<IFolderInfo>

GetFolders(UserInfo, string)

Declaration

IEnumerable<IFolderInfo> GetFolders(UserInfo user, string permissions)

Parameters

Type	Name	Description
UserInfo	user
string	permissions

Returns

Type	Description
IEnumerable<IFolderInfo>

GetFolders(IFolderInfo)

Declaration

IEnumerable<IFolderInfo> GetFolders(IFolderInfo parentFolder)

Parameters

Type	Name	Description
IFolderInfo	parentFolder

Returns

Type	Description
IEnumerable<IFolderInfo>

GetFolders(int)

Declaration

IEnumerable<IFolderInfo> GetFolders(int portalId)

Parameters

Type	Name	Description
int	portalId

Returns

Type	Description
IEnumerable<IFolderInfo>

GetFolders(int, bool)

Declaration

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

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

IFolderInfo GetUserFolder(UserInfo userInfo)

Parameters

Type	Name	Description
UserInfo	userInfo

Returns

Type	Description
IFolderInfo

MoveFolder(IFolderInfo, IFolderInfo)

Declaration

IFolderInfo MoveFolder(IFolderInfo folder, IFolderInfo destinationFolder)

Parameters

Type	Name	Description
IFolderInfo	folder
IFolderInfo	destinationFolder

Returns

Type	Description
IFolderInfo

RenameFolder(IFolderInfo, string)

Declaration

void RenameFolder(IFolderInfo folder, string newFolderName)

Parameters

Type	Name	Description
IFolderInfo	folder
string	newFolderName

SearchFiles(IFolderInfo, string, bool)

Declaration

IEnumerable<IFileInfo> SearchFiles(IFolderInfo folder, string pattern, bool recursive = false)

Parameters

Type	Name	Description
IFolderInfo	folder
string	pattern
bool	recursive

Returns

Type	Description
IEnumerable<IFileInfo>

SetFolderPermission(IFolderInfo, int, int)

Declaration

void SetFolderPermission(IFolderInfo folder, int permissionId, int roleId)

Parameters

Type	Name	Description
IFolderInfo	folder
int	permissionId
int	roleId

SetFolderPermission(IFolderInfo, int, int, int)

Declaration

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

void SetFolderPermissions(IFolderInfo folder, int administratorRoleId)

Parameters

Type	Name	Description
IFolderInfo	folder
int	administratorRoleId

Synchronize(int)

Declaration

int Synchronize(int portalId)

Parameters

Type	Name	Description
int	portalId

Returns

Type	Description
int

Synchronize(int, string)

Declaration

int Synchronize(int portalId, string relativePath)

Parameters

Type	Name	Description
int	portalId
string	relativePath

Returns

Type	Description
int

Synchronize(int, string, bool, bool)

Declaration

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

void UnlinkFolder(IFolderInfo folder)

Parameters

Type	Name	Description
IFolderInfo	folder

UpdateFolder(IFolderInfo)

Declaration

IFolderInfo UpdateFolder(IFolderInfo folder)

Parameters

Type	Name	Description
IFolderInfo	folder

Returns

Type	Description
IFolderInfo

Extension Methods

JsonExtensionsWeb.ToJson(object)