Interface IFileManager

Namespace: DotNetNuke.Services.FileSystem
Assembly: DotNetNuke.dll
Syntax
public interface IFileManager

Properties

ContentTypes

Declaration
[Obsolete("Deprecated in DotNetNuke 7.4.2. It has been replaced by FileContentTypeManager.Instance.ContentTypes. Scheduled for removal in v10.0.0.")]
IDictionary<string, string> ContentTypes { get; }
Property Value
Type Description
IDictionary<string, string>

WhiteList

Declaration
FileExtensionWhitelist WhiteList { get; }
Property Value
Type Description
FileExtensionWhitelist

Methods

AddFile(IFolderInfo, string, Stream)

Declaration
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
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
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
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
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
IFileInfo CopyFile(IFileInfo file, IFolderInfo destinationFolder)
Parameters
Type Name Description
IFileInfo file
IFolderInfo destinationFolder
Returns
Type Description
IFileInfo

DeleteFile(IFileInfo)

Declaration
void DeleteFile(IFileInfo file)
Parameters
Type Name Description
IFileInfo file

DeleteFiles(IEnumerable<IFileInfo>)

Declaration
void DeleteFiles(IEnumerable<IFileInfo> files)
Parameters
Type Name Description
IEnumerable<IFileInfo> files

FileExists(IFolderInfo, string)

Declaration
bool FileExists(IFolderInfo folder, string fileName)
Parameters
Type Name Description
IFolderInfo folder
string fileName
Returns
Type Description
bool

FileExists(IFolderInfo, string, bool)

Declaration
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
[Obsolete("Deprecated in DotNetNuke 7.4.2. It has been replaced by FileContentTypeManager.Instance.GetContentType(string extension). Scheduled for removal in v10.0.0.")]
string GetContentType(string extension)
Parameters
Type Name Description
string extension
Returns
Type Description
string

GetFile(IFolderInfo, string)

Declaration
IFileInfo GetFile(IFolderInfo folder, string fileName)
Parameters
Type Name Description
IFolderInfo folder
string fileName
Returns
Type Description
IFileInfo

GetFile(IFolderInfo, string, bool)

Declaration
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
IFileInfo GetFile(int fileID)
Parameters
Type Name Description
int fileID
Returns
Type Description
IFileInfo

GetFile(int, bool)

Declaration
IFileInfo GetFile(int fileID, bool retrieveUnpublishedFiles)
Parameters
Type Name Description
int fileID
bool retrieveUnpublishedFiles
Returns
Type Description
IFileInfo

GetFile(int, string)

Declaration
IFileInfo GetFile(int portalId, string relativePath)
Parameters
Type Name Description
int portalId
string relativePath
Returns
Type Description
IFileInfo

GetFile(int, string, bool)

Declaration
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
Stream GetFileContent(IFileInfo file)
Parameters
Type Name Description
IFileInfo file
Returns
Type Description
Stream

GetSeekableStream(Stream)

Declaration
Stream GetSeekableStream(Stream stream)
Parameters
Type Name Description
Stream stream
Returns
Type Description
Stream

GetUrl(IFileInfo)

Declaration
string GetUrl(IFileInfo file)
Parameters
Type Name Description
IFileInfo file
Returns
Type Description
string

IsImageFile(IFileInfo)

Declaration
bool IsImageFile(IFileInfo file)
Parameters
Type Name Description
IFileInfo file
Returns
Type Description
bool

MoveFile(IFileInfo, IFolderInfo)

Declaration
IFileInfo MoveFile(IFileInfo file, IFolderInfo destinationFolder)
Parameters
Type Name Description
IFileInfo file
IFolderInfo destinationFolder
Returns
Type Description
IFileInfo

RenameFile(IFileInfo, string)

Declaration
IFileInfo RenameFile(IFileInfo file, string newFileName)
Parameters
Type Name Description
IFileInfo file
string newFileName
Returns
Type Description
IFileInfo

SetAttributes(IFileInfo, FileAttributes)

Declaration
void SetAttributes(IFileInfo file, FileAttributes fileAttributes)
Parameters
Type Name Description
IFileInfo file
FileAttributes fileAttributes

UnzipFile(IFileInfo)

Declaration
void UnzipFile(IFileInfo file)
Parameters
Type Name Description
IFileInfo file

UnzipFile(IFileInfo, IFolderInfo)

Declaration
void UnzipFile(IFileInfo file, IFolderInfo destinationFolder)
Parameters
Type Name Description
IFileInfo file
IFolderInfo destinationFolder

UnzipFile(IFileInfo, IFolderInfo, IList<string>)

Declaration
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
IFileInfo UpdateFile(IFileInfo file)
Parameters
Type Name Description
IFileInfo file
Returns
Type Description
IFileInfo

UpdateFile(IFileInfo, Stream)

Declaration
IFileInfo UpdateFile(IFileInfo file, Stream fileContent)
Parameters
Type Name Description
IFileInfo file
Stream fileContent
Returns
Type Description
IFileInfo

WriteFile(IFileInfo, Stream)

Declaration
void WriteFile(IFileInfo file, Stream stream)
Parameters
Type Name Description
IFileInfo file
Stream stream

WriteFileToResponse(IFileInfo, ContentDisposition)

Declaration
void WriteFileToResponse(IFileInfo file, ContentDisposition contentDisposition)
Parameters
Type Name Description
IFileInfo file
ContentDisposition contentDisposition

Extension Methods