Class FolderProvider

Inheritance

object

FolderProvider

StandardFolderProvider

Inherited Members

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 abstract class FolderProvider

Constructors

FolderProvider()

Declaration

protected FolderProvider()

Properties

IsStorageSecure

Declaration

public virtual bool IsStorageSecure { get; }

Property Value

Type	Description
bool

RequiresNetworkConnectivity

Declaration

public virtual bool RequiresNetworkConnectivity { get; }

Property Value

Type	Description
bool

SupportsMappedPaths

Declaration

public virtual bool SupportsMappedPaths { get; }

Property Value

Type	Description
bool

SupportsMoveFile

Declaration

public virtual bool SupportsMoveFile { get; }

Property Value

Type	Description
bool

SupportsMoveFolder

Declaration

public virtual bool SupportsMoveFolder { get; }

Property Value

Type	Description
bool

Methods

AddFile(IFolderInfo, string, Stream)

Declaration

public abstract void AddFile(IFolderInfo folder, string fileName, Stream content)

Parameters

Type	Name	Description
IFolderInfo	folder
string	fileName
Stream	content

AddFolder(string, FolderMappingInfo)

Declaration

public abstract void AddFolder(string folderPath, FolderMappingInfo folderMapping)

Parameters

Type	Name	Description
string	folderPath
FolderMappingInfo	folderMapping

AddFolder(string, FolderMappingInfo, string)

Declaration

public virtual void AddFolder(string folderPath, FolderMappingInfo folderMapping, string mappedPath)

Parameters

Type	Name	Description
string	folderPath
FolderMappingInfo	folderMapping
string	mappedPath

CopyFile(string, string, string, FolderMappingInfo)

Declaration

public virtual void CopyFile(string folderPath, string fileName, string newFolderPath, FolderMappingInfo folderMapping)

Parameters

Type	Name	Description
string	folderPath
string	fileName
string	newFolderPath
FolderMappingInfo	folderMapping

DeleteFile(IFileInfo)

Declaration

public abstract void DeleteFile(IFileInfo file)

Parameters

Type	Name	Description
IFileInfo	file

DeleteFolder(IFolderInfo)

Declaration

public abstract void DeleteFolder(IFolderInfo folder)

Parameters

Type	Name	Description
IFolderInfo	folder

EncryptValue(string)

Declaration

public string EncryptValue(string settingValue)

Parameters

Type	Name	Description
string	settingValue

Returns

Type	Description
string

FileExists(IFolderInfo, string)

Declaration

public abstract bool FileExists(IFolderInfo folder, string fileName)

Parameters

Type	Name	Description
IFolderInfo	folder
string	fileName

Returns

Type	Description
bool

FolderExists(string, FolderMappingInfo)

Declaration

public abstract bool FolderExists(string folderPath, FolderMappingInfo folderMapping)

Parameters

Type	Name	Description
string	folderPath
FolderMappingInfo	folderMapping

Returns

Type	Description
bool

GetEncryptedSetting(Hashtable, string)

Declaration

public string GetEncryptedSetting(Hashtable folderMappingSettings, string settingName)

Parameters

Type	Name	Description
Hashtable	folderMappingSettings
string	settingName

Returns

Type	Description
string

GetFileAttributes(IFileInfo)

Declaration

public abstract FileAttributes? GetFileAttributes(IFileInfo file)

Parameters

Type	Name	Description
IFileInfo	file

Returns

Type	Description
FileAttributes?

GetFileSize(IFileInfo)

Declaration

public abstract long GetFileSize(IFileInfo file)

Parameters

Type	Name	Description
IFileInfo	file

Returns

Type	Description
long

GetFileStream(IFileInfo)

Declaration

public abstract Stream GetFileStream(IFileInfo file)

Parameters

Type	Name	Description
IFileInfo	file

Returns

Type	Description
Stream

GetFileStream(IFolderInfo, IFileInfo, int)

Declaration

public virtual Stream GetFileStream(IFolderInfo folder, IFileInfo file, int version)

Parameters

Type	Name	Description
IFolderInfo	folder
IFileInfo	file
int	version

Returns

Type	Description
Stream

GetFileStream(IFolderInfo, string)

Declaration

public abstract Stream GetFileStream(IFolderInfo folder, string fileName)

Parameters

Type	Name	Description
IFolderInfo	folder
string	fileName

Returns

Type	Description
Stream

GetFileUrl(IFileInfo)

Declaration

public abstract string GetFileUrl(IFileInfo file)

Parameters

Type	Name	Description
IFileInfo	file

Returns

Type	Description
string

GetFiles(IFolderInfo)

Declaration

public abstract string[] GetFiles(IFolderInfo folder)

Parameters

Type	Name	Description
IFolderInfo	folder

Returns

Type	Description
string[]

GetFolderProviderIconPath()

Declaration

public abstract string GetFolderProviderIconPath()

Returns

Type	Description
string

GetHashCode(IFileInfo)

Declaration

public virtual string GetHashCode(IFileInfo file)

Parameters

Type	Name	Description
IFileInfo	file

Returns

Type	Description
string

GetHashCode(IFileInfo, Stream)

Declaration

public virtual string GetHashCode(IFileInfo file, Stream fileContent)

Parameters

Type	Name	Description
IFileInfo	file
Stream	fileContent

Returns

Type	Description
string

GetLastModificationTime(IFileInfo)

Declaration

public abstract DateTime GetLastModificationTime(IFileInfo file)

Parameters

Type	Name	Description
IFileInfo	file

Returns

Type	Description
DateTime

GetProviderList()

Declaration

public static Dictionary<string, FolderProvider> GetProviderList()

Returns

Type	Description
Dictionary<string, FolderProvider>

GetSettingsControlVirtualPath()

Declaration

public virtual string GetSettingsControlVirtualPath()

Returns

Type	Description
string

GetSubFolders(string, FolderMappingInfo)

Declaration

public abstract IEnumerable<string> GetSubFolders(string folderPath, FolderMappingInfo folderMapping)

Parameters

Type	Name	Description
string	folderPath
FolderMappingInfo	folderMapping

Returns

Type	Description
IEnumerable<string>

Instance(string)

Declaration

public static FolderProvider Instance(string friendlyName)

Parameters

Type	Name	Description
string	friendlyName

Returns

Type	Description
FolderProvider

IsInSync(IFileInfo)

Declaration

public abstract bool IsInSync(IFileInfo file)

Parameters

Type	Name	Description
IFileInfo	file

Returns

Type	Description
bool

MoveFile(IFileInfo, IFolderInfo)

Declaration

public virtual void MoveFile(IFileInfo file, IFolderInfo destinationFolder)

Parameters

Type	Name	Description
IFileInfo	file
IFolderInfo	destinationFolder

MoveFolder(string, string, FolderMappingInfo)

Declaration

public virtual void MoveFolder(string folderPath, string newFolderPath, FolderMappingInfo folderMapping)

Parameters

Type	Name	Description
string	folderPath
string	newFolderPath
FolderMappingInfo	folderMapping

RenameFile(IFileInfo, string)

Declaration

public abstract void RenameFile(IFileInfo file, string newFileName)

Parameters

Type	Name	Description
IFileInfo	file
string	newFileName

RenameFolder(IFolderInfo, string)

Declaration

public abstract void RenameFolder(IFolderInfo folder, string newFolderName)

Parameters

Type	Name	Description
IFolderInfo	folder
string	newFolderName

SetFileAttributes(IFileInfo, FileAttributes)

Declaration

public abstract void SetFileAttributes(IFileInfo file, FileAttributes fileAttributes)

Parameters

Type	Name	Description
IFileInfo	file
FileAttributes	fileAttributes

SupportsFileAttributes()

Declaration

public abstract bool SupportsFileAttributes()

Returns

Type	Description
bool

UpdateFile(IFileInfo, Stream)

Declaration

public abstract void UpdateFile(IFileInfo file, Stream content)

Parameters

Type	Name	Description
IFileInfo	file
Stream	content

UpdateFile(IFolderInfo, string, Stream)

Declaration

public abstract void UpdateFile(IFolderInfo folder, string fileName, Stream content)

Parameters

Type	Name	Description
IFolderInfo	folder
string	fileName
Stream	content

Extension Methods

JsonExtensionsWeb.ToJson(object)