IMigratableCentralizedFileStorageProvider Provider Type

Ben Tiedt — Tue, 19 Nov 2019 19:35:38 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/19/2019 19:35:38

IMigratableCentralizedFileStorageProvider is defined in the Telligent.Evolution.Extensibility.Storage.Version1 namespace of Telligent.Evolution.Platform.dll

Definition

interface IMigratableCentralizedFileStorageProvider : [[ICentralizedFileStorageProvider Provider Type|ICentralizedFileStorageProvider]]
{
	string FileStoreKey { get;  }
	[[ICentralizedFileStorageProvider Plugin Supplementary Type|ICentralizedFileStorageProvider]] SourceProvider { get;  }
	[[ICentralizedFile Plugin Supplementary Type|ICentralizedFile]] AddFile(string path, string fileName, Stream contentStream, bool ensureUniqueFileName);
	void AddPath(string path);
	[[ICentralizedFile Plugin Supplementary Type|ICentralizedFile]] AddUpdateFile(string path, string fileName, Stream contentStream);
	void Delete(string path, string fileName);
	void Delete();
	void Delete(string path);
	[[ICentralizedFile Plugin Supplementary Type|ICentralizedFile]] GetFile(string path, string fileName, bool fallbackToSource);
	[[ICentralizedFile Plugin Supplementary Type|ICentralizedFile]] GetFile(string path, string fileName);
	IEnumerable<[[ICentralizedFile Plugin Supplementary Type|ICentralizedFile]]> GetFiles(string path, [[PathSearchOption Plugin Supplementary Type|PathSearchOption]] searchOption, bool fallbackToSource);
	IEnumerable<[[ICentralizedFile Plugin Supplementary Type|ICentralizedFile]]> GetFiles([[PathSearchOption Plugin Supplementary Type|PathSearchOption]] searchOption);
	IEnumerable<[[ICentralizedFile Plugin Supplementary Type|ICentralizedFile]]> GetFiles(string path, [[PathSearchOption Plugin Supplementary Type|PathSearchOption]] searchOption);
	IEnumerable<string> GetPaths();
	IEnumerable<string> GetPaths(string path);
	void Initialize(string fileStoreKey, XmlNode configurationNode);
	void RegisterMigrationSource([[ICentralizedFileStorageProvider Plugin Supplementary Type|ICentralizedFileStorageProvider]] migrationSourcce, [[IMigratableCentralizedFileStorageProviderController Plugin Supplementary Type|IMigratableCentralizedFileStorageProviderController]] controller);
}

Properties

Name	Type	Description	Default	Options
FileStoreKey	`string`
SourceProvider	`[[ICentralizedFileStorageProvider Plugin Supplementary Type\|ICentralizedFileStorageProvider]]`

Methods

ICentralizedFile AddFile(string path, string fileName, Stream contentStream, bool ensureUniqueFileName);

Parameters

Name	Type	Description	Required
path	`string`	Path	Required
fileName	`string`	File Name	Required
contentStream	`Stream`	Content Stream	Required
ensureUniqueFileName	`bool`	Ensure Unique File Name	Required

Return Type

[[ICentralizedFile Plugin Supplementary Type|ICentralizedFile]]

void AddPath(string path);

Parameters

Name	Type	Description	Required	Default	Options
path	`string`	Path	Required

ICentralizedFile AddUpdateFile(string path, string fileName, Stream contentStream);

Parameters

Name	Type	Description	Required
path	`string`	Path	Required
fileName	`string`	File Name	Required
contentStream	`Stream`	Content Stream	Required

Return Type

[[ICentralizedFile Plugin Supplementary Type|ICentralizedFile]]

void Delete(string path, string fileName);

Parameters

Name	Type	Description	Required	Default	Options
path	`string`	Path	Required
fileName	`string`	File Name	Required

void Delete();

void Delete(string path);

Parameters

Name	Type	Description	Required	Default	Options
path	`string`	Path	Required

ICentralizedFile GetFile(string path, string fileName, bool fallbackToSource);

Parameters

Name	Type	Description	Required
path	`string`	Path	Required
fileName	`string`	File Name	Required
fallbackToSource	`bool`	Fallback To Source	Required

Return Type

[[ICentralizedFile Plugin Supplementary Type|ICentralizedFile]]

ICentralizedFile GetFile(string path, string fileName);

Parameters

Name	Type	Description	Required	Default	Options
path	`string`	Path	Required
fileName	`string`	File Name	Required

Return Type

[[ICentralizedFile Plugin Supplementary Type|ICentralizedFile]]

IEnumerable<ICentralizedFile> GetFiles(string path, PathSearchOption searchOption, bool fallbackToSource);

Parameters

Name	Type	Description	Required
path	`string`	Path	Required
searchOption	`[[PathSearchOption Plugin Supplementary Type\|PathSearchOption]]`	Search Option	Required
fallbackToSource	`bool`	Fallback To Source	Required

Return Type

IEnumerable<[[ICentralizedFile Plugin Supplementary Type|ICentralizedFile]]>

IEnumerable<ICentralizedFile> GetFiles(PathSearchOption searchOption);

Parameters

Name	Type	Description	Required	Default	Options
searchOption	`[[PathSearchOption Plugin Supplementary Type\|PathSearchOption]]`	Search Option	Required

Return Type

IEnumerable<[[ICentralizedFile Plugin Supplementary Type|ICentralizedFile]]>

IEnumerable<ICentralizedFile> GetFiles(string path, PathSearchOption searchOption);

Parameters

Name	Type	Description	Required	Default	Options
path	`string`	Path	Required
searchOption	`[[PathSearchOption Plugin Supplementary Type\|PathSearchOption]]`	Search Option	Required

Return Type

IEnumerable<[[ICentralizedFile Plugin Supplementary Type|ICentralizedFile]]>

IEnumerable<string> GetPaths();

Return Type

IEnumerable<string>

IEnumerable<string> GetPaths(string path);

Parameters

Name	Type	Description	Required	Default	Options
path	`string`	Path	Required

Return Type

IEnumerable<string>

void Initialize(string fileStoreKey, XmlNode configurationNode);

Parameters

Name	Type	Description	Required	Default	Options
fileStoreKey	`string`	File Store Key	Required
configurationNode	`XmlNode`	Configuration Node	Required

void RegisterMigrationSource(ICentralizedFileStorageProvider migrationSourcce, IMigratableCentralizedFileStorageProviderController controller);

Parameters

Name	Type	Description	Required	Default	Options
migrationSourcce	`[[ICentralizedFileStorageProvider Plugin Supplementary Type\|ICentralizedFileStorageProvider]]`	Migration Sourcce	Required
controller	`[[IMigratableCentralizedFileStorageProviderController Plugin Supplementary Type\|IMigratableCentralizedFileStorageProviderController]]`	Controller	Required