Class FileManager

Inheritance

object

ComponentBase<IFileManager, FileManager>

FileManager

Implements

IFileManager

Inherited Members

ComponentBase<IFileManager, FileManager>.RegisterInstance(IFileManager)

ComponentBase<IFileManager, FileManager>.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 FileManager : ComponentBase<IFileManager, FileManager>, IFileManager

Constructors

FileManager()

Declaration

[Obsolete("Deprecated in DotNetNuke 10.2.4. Please use overload with IFileSecurityController. Scheduled removal in v12.0.0.")]
public FileManager()

FileManager(IFileSecurityController, IFileLockingController, IFileVersionController, IFileDeletionController, IFileContentTypeManager, IFolderMappingController, IFolderPermissionController, ISystemWorkflowManager, IWorkflowManager, IWorkflowEngine, IWorkflowSecurity, IUserController, IContentController, IContentTypeController, ITermController, IHostSettings, ICBO, IEventManager, IEventLogger, IPortalController, DataProvider, IPathUtils)

Declaration

public FileManager(IFileSecurityController fileSecurityController, IFileLockingController fileLockingController, IFileVersionController fileVersionController, IFileDeletionController fileDeletionController, IFileContentTypeManager fileContentTypeManager, IFolderMappingController folderMappingController, IFolderPermissionController folderPermissionController, ISystemWorkflowManager systemWorkflowManager, IWorkflowManager workflowManager, IWorkflowEngine workflowEngine, IWorkflowSecurity workflowSecurity, IUserController userController, IContentController contentController, IContentTypeController contentTypeController, ITermController termController, IHostSettings hostSettings, ICBO cbo, IEventManager eventManager, IEventLogger eventLogger, IPortalController portalController, DataProvider dataProvider, IPathUtils pathUtils)

Parameters

Type	Name	Description
IFileSecurityController	fileSecurityController
IFileLockingController	fileLockingController
IFileVersionController	fileVersionController
IFileDeletionController	fileDeletionController
IFileContentTypeManager	fileContentTypeManager
IFolderMappingController	folderMappingController
IFolderPermissionController	folderPermissionController
ISystemWorkflowManager	systemWorkflowManager
IWorkflowManager	workflowManager
IWorkflowEngine	workflowEngine
IWorkflowSecurity	workflowSecurity
IUserController	userController
IContentController	contentController
IContentTypeController	contentTypeController
ITermController	termController
IHostSettings	hostSettings
ICBO	cbo
IEventManager	eventManager
IEventLogger	eventLogger
IPortalController	portalController
DataProvider	dataProvider
IPathUtils	pathUtils

Properties

ContentTypes

Declaration

public virtual IDictionary<string, string> ContentTypes { get; }

Property Value

Type	Description
IDictionary<string, string>

WhiteList

Declaration

public FileExtensionWhitelist WhiteList { get; }

Property Value

Type	Description
FileExtensionWhitelist

Methods

AddFile(IFolderInfo, string, Stream)

Declaration

public virtual IFileInfo AddFile(IFolderInfo folder, string fileName, Stream fileContent)

Parameters

Type	Name	Description
IFolderInfo	folder
string	fileName
Stream	fileContent

Returns

Type	Description
IFileInfo

AddFile(IFolderInfo, string, Stream, bool)

Declaration

public virtual IFileInfo AddFile(IFolderInfo folder, string fileName, Stream fileContent, bool overwrite)

Parameters

Type	Name	Description
IFolderInfo	folder
string	fileName
Stream	fileContent
bool	overwrite

Returns

Type	Description
IFileInfo

AddFile(IFolderInfo, string, Stream, bool, bool, bool, string, int)

Declaration

public virtual IFileInfo AddFile(IFolderInfo folder, string fileName, Stream fileContent, bool overwrite, bool checkPermissions, bool ignoreWhiteList, string contentType, int createdByUserID)

Parameters

Type	Name	Description
IFolderInfo	folder
string	fileName
Stream	fileContent
bool	overwrite
bool	checkPermissions
bool	ignoreWhiteList
string	contentType
int	createdByUserID

Returns

Type	Description
IFileInfo

AddFile(IFolderInfo, string, Stream, bool, bool, string)

Declaration

public virtual IFileInfo AddFile(IFolderInfo folder, string fileName, Stream fileContent, bool overwrite, bool checkPermissions, string contentType)

Parameters

Type	Name	Description
IFolderInfo	folder
string	fileName
Stream	fileContent
bool	overwrite
bool	checkPermissions
string	contentType

Returns

Type	Description
IFileInfo

AddFile(IFolderInfo, string, Stream, bool, bool, string, int)

Declaration

public virtual IFileInfo AddFile(IFolderInfo folder, string fileName, Stream fileContent, bool overwrite, bool checkPermissions, string contentType, int createdByUserID)

Parameters

Type	Name	Description
IFolderInfo	folder
string	fileName
Stream	fileContent
bool	overwrite
bool	checkPermissions
string	contentType
int	createdByUserID

Returns

Type	Description
IFileInfo

CopyFile(IFileInfo, IFolderInfo)

Declaration

public virtual IFileInfo CopyFile(IFileInfo file, IFolderInfo destinationFolder)

Parameters

Type	Name	Description
IFileInfo	file
IFolderInfo	destinationFolder

Returns

Type	Description
IFileInfo

DeleteFile(IFileInfo)

Declaration

public virtual void DeleteFile(IFileInfo file)

Parameters

Type	Name	Description
IFileInfo	file

DeleteFiles(IEnumerable<IFileInfo>)

Declaration

public virtual void DeleteFiles(IEnumerable<IFileInfo> files)

Parameters

Type	Name	Description
IEnumerable<IFileInfo>	files

FileExists(IFolderInfo, string)

Declaration

public virtual bool FileExists(IFolderInfo folder, string fileName)

Parameters

Type	Name	Description
IFolderInfo	folder
string	fileName

Returns

Type	Description
bool

FileExists(IFolderInfo, string, bool)

Declaration

public virtual bool FileExists(IFolderInfo folder, string fileName, bool retrieveUnpublishedFiles)

Parameters

Type	Name	Description
IFolderInfo	folder
string	fileName
bool	retrieveUnpublishedFiles

Returns

Type	Description
bool

GetContentType(string)

Declaration

public virtual string GetContentType(string extension)

Parameters

Type	Name	Description
string	extension

Returns

Type	Description
string

GetFile(IFolderInfo, string)

Declaration

public virtual IFileInfo GetFile(IFolderInfo folder, string fileName)

Parameters

Type	Name	Description
IFolderInfo	folder
string	fileName

Returns

Type	Description
IFileInfo

GetFile(IFolderInfo, string, bool)

Declaration

public virtual IFileInfo GetFile(IFolderInfo folder, string fileName, bool retrieveUnpublishedFiles)

Parameters

Type	Name	Description
IFolderInfo	folder
string	fileName
bool	retrieveUnpublishedFiles

Returns

Type	Description
IFileInfo

GetFile(int)

Declaration

public virtual IFileInfo GetFile(int fileID)

Parameters

Type	Name	Description
int	fileID

Returns

Type	Description
IFileInfo

GetFile(int, bool)

Declaration

public virtual IFileInfo GetFile(int fileID, bool retrieveUnpublishedFiles)

Parameters

Type	Name	Description
int	fileID
bool	retrieveUnpublishedFiles

Returns

Type	Description
IFileInfo

GetFile(int, string)

Declaration

public virtual IFileInfo GetFile(int portalId, string relativePath)

Parameters

Type	Name	Description
int	portalId
string	relativePath

Returns

Type	Description
IFileInfo

GetFile(int, string, bool)

Declaration

public virtual IFileInfo GetFile(int portalId, string relativePath, bool retrieveUnpublishedFiles)

Parameters

Type	Name	Description
int	portalId
string	relativePath
bool	retrieveUnpublishedFiles

Returns

Type	Description
IFileInfo

GetFileContent(IFileInfo)

Declaration

public virtual Stream GetFileContent(IFileInfo file)

Parameters

Type	Name	Description
IFileInfo	file

Returns

Type	Description
Stream

GetSeekableStream(Stream)

Declaration

public virtual Stream GetSeekableStream(Stream stream)

Parameters

Type	Name	Description
Stream	stream

Returns

Type	Description
Stream

GetUrl(IFileInfo)

Declaration

public string GetUrl(IFileInfo file)

Parameters

Type	Name	Description
IFileInfo	file

Returns

Type	Description
string

IsImageFile(IFileInfo)

Declaration

public virtual bool IsImageFile(IFileInfo file)

Parameters

Type	Name	Description
IFileInfo	file

Returns

Type	Description
bool

MoveFile(IFileInfo, IFolderInfo)

Declaration

public virtual IFileInfo MoveFile(IFileInfo file, IFolderInfo destinationFolder)

Parameters

Type	Name	Description
IFileInfo	file
IFolderInfo	destinationFolder

Returns

Type	Description
IFileInfo

RenameFile(IFileInfo, string)

Declaration

public virtual IFileInfo RenameFile(IFileInfo file, string newFileName)

Parameters

Type	Name	Description
IFileInfo	file
string	newFileName

Returns

Type	Description
IFileInfo

SetAttributes(IFileInfo, FileAttributes)

Declaration

public void SetAttributes(IFileInfo file, FileAttributes fileAttributes)

Parameters

Type	Name	Description
IFileInfo	file
FileAttributes	fileAttributes

UnzipFile(IFileInfo)

Declaration

public virtual void UnzipFile(IFileInfo file)

Parameters

Type	Name	Description
IFileInfo	file

UnzipFile(IFileInfo, IFolderInfo)

Declaration

public virtual void UnzipFile(IFileInfo file, IFolderInfo destinationFolder)

Parameters

Type	Name	Description
IFileInfo	file
IFolderInfo	destinationFolder

UnzipFile(IFileInfo, IFolderInfo, IList<string>)

Declaration

public virtual int UnzipFile(IFileInfo file, IFolderInfo destinationFolder, IList<string> invalidFiles)

Parameters

Type	Name	Description
IFileInfo	file
IFolderInfo	destinationFolder
IList<string>	invalidFiles

Returns

Type	Description
int

UpdateFile(IFileInfo)

Declaration

public virtual IFileInfo UpdateFile(IFileInfo file)

Parameters

Type	Name	Description
IFileInfo	file

Returns

Type	Description
IFileInfo

UpdateFile(IFileInfo, Stream)

Declaration

public virtual IFileInfo UpdateFile(IFileInfo file, Stream fileContent)

Parameters

Type	Name	Description
IFileInfo	file
Stream	fileContent

Returns

Type	Description
IFileInfo

WriteFile(IFileInfo, Stream)

Declaration

public virtual void WriteFile(IFileInfo file, Stream stream)

Parameters

Type	Name	Description
IFileInfo	file
Stream	stream

WriteFileToResponse(IFileInfo, ContentDisposition)

Declaration

public virtual void WriteFileToResponse(IFileInfo file, ContentDisposition contentDisposition)

Parameters

Type	Name	Description
IFileInfo	file
ContentDisposition	contentDisposition

Implements

IFileManager

Extension Methods

JsonExtensionsWeb.ToJson(object)