ICentralizedFileStorageProvider Provider Type

ICentralizedFileStorageProvider is defined in the Telligent.Evolution.Extensibility.Storage.Version1 namespace.

Definition

interface ICentralizedFileStorageProvider
{
	ICentralizedFileEventExecutor EventExecutor { set;  }
	string FileStoreKey { get;  }
	ICentralizedFileStorageProvider SourceProvider { get;  }
	ICentralizedFile AddFile(string path, string fileName, Stream contentStream, bool ensureUniqueFileName, bool writeBehind = False);
	Task<ICentralizedFile> AddFileAsync(string path, string fileName, Stream contentStream, bool ensureUniqueFileName, bool writeBehind = False);
	void AddPath(string path);
	Task AddPathAsync(string path);
	ICentralizedFile AddUpdateFile(string path, string fileName, Stream contentStream, bool writeBehind = False);
	Task<ICentralizedFile> AddUpdateFileAsync(string path, string fileName, Stream contentStream, bool writeBehind = False);
	void Delete();
	void Delete(string path);
	void Delete(string path, string fileName);
	Task DeleteAsync(string path, string fileName);
	Task DeleteAsync();
	Task DeleteAsync(string path);
	string GetDeliveryUrlPathAndQuery(ICentralizedFile file);
	Task<string> GetDeliveryUrlPathAndQueryAsync(ICentralizedFile file);
	ICentralizedFile GetFile(string path, string fileName, bool fallbackToSource = True, FileStorageLocation from = All);
	Task<ICentralizedFile> GetFileAsync(string path, string fileName, bool fallbackToSource = True, FileStorageLocation from = All);
	IEnumerable<ICentralizedFile> GetFiles(string path, PathSearchOption searchOption, bool fallbackToSource);
	IEnumerable<ICentralizedFile> GetFiles(string path, PathSearchOption searchOption);
	IEnumerable<ICentralizedFile> GetFiles(PathSearchOption searchOption);
	Task<IEnumerable<ICentralizedFile>> GetFilesAsync(PathSearchOption searchOption);
	Task<IEnumerable<ICentralizedFile>> GetFilesAsync(string path, PathSearchOption searchOption, bool fallbackToSource);
	Task<IEnumerable<ICentralizedFile>> GetFilesAsync(string path, PathSearchOption searchOption);
	IEnumerable<string> GetPaths(string path);
	IEnumerable<string> GetPaths();
	Task<IEnumerable<string>> GetPathsAsync(string path);
	Task<IEnumerable<string>> GetPathsAsync();
	Task<bool> HandleHttpRequestAsync(HttpContext context, ICentralizedFile file);
	void Initialize(string fileStoreKey, Dictionary<string,string> configuration);
	void RegisterMigrationSource(ICentralizedFileStorageProvider migrationSourcce, IMigratableCentralizedFileStorageProviderController controller);
}

Properties

Name	Type	Description	Default	Options
EventExecutor	`ICentralizedFileEventExecutor`
FileStoreKey	`string`
SourceProvider	`ICentralizedFileStorageProvider`

Methods

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

Parameters

Name	Type	Description	Required	Default
path	`string`	Path	Required
fileName	`string`	File Name	Required
contentStream	`Stream`	Content Stream	Required
ensureUniqueFileName	`bool`	Ensure Unique File Name	Required
writeBehind	`bool`	Write Behind	Optional	False

Return Type

ICentralizedFile

Task<ICentralizedFile> AddFileAsync(string path, string fileName, Stream contentStream, bool ensureUniqueFileName, bool writeBehind = False);

Parameters

Name	Type	Description	Required	Default
path	`string`	Path	Required
fileName	`string`	File Name	Required
contentStream	`Stream`	Content Stream	Required
ensureUniqueFileName	`bool`	Ensure Unique File Name	Required
writeBehind	`bool`	Write Behind	Optional	False

Return Type

Task<ICentralizedFile>

void AddPath(string path);

Parameters

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

Task AddPathAsync(string path);

Parameters

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

Return Type

Task

ICentralizedFile AddUpdateFile(string path, string fileName, Stream contentStream, bool writeBehind = False);

Parameters

Name	Type	Description	Required	Default
path	`string`	Path	Required
fileName	`string`	File Name	Required
contentStream	`Stream`	Content Stream	Required
writeBehind	`bool`	Write Behind	Optional	False

Return Type

ICentralizedFile

Task<ICentralizedFile> AddUpdateFileAsync(string path, string fileName, Stream contentStream, bool writeBehind = False);

Parameters

Name	Type	Description	Required	Default
path	`string`	Path	Required
fileName	`string`	File Name	Required
contentStream	`Stream`	Content Stream	Required
writeBehind	`bool`	Write Behind	Optional	False

Return Type

Task<ICentralizedFile>

void Delete();

void Delete(string path);

Parameters

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

void Delete(string path, string fileName);

Parameters

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

Task DeleteAsync(string path, string fileName);

Parameters

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

Return Type

Task

Task DeleteAsync();

Return Type

Task

Task DeleteAsync(string path);

Parameters

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

Return Type

Task

string GetDeliveryUrlPathAndQuery(ICentralizedFile file);

Parameters

Name	Type	Description	Required	Default	Options
file	`ICentralizedFile`	File	Required

Return Type

string

Task<string> GetDeliveryUrlPathAndQueryAsync(ICentralizedFile file);

Parameters

Name	Type	Description	Required	Default	Options
file	`ICentralizedFile`	File	Required

Return Type

Task<string>

ICentralizedFile GetFile(string path, string fileName, bool fallbackToSource = True, FileStorageLocation from = All);

Parameters

Name	Type	Description	Required	Default
path	`string`	Path	Required
fileName	`string`	File Name	Required
fallbackToSource	`bool`	Fallback To Source	Optional	True
from	`FileStorageLocation`	From	Optional	All

Return Type

ICentralizedFile

Task<ICentralizedFile> GetFileAsync(string path, string fileName, bool fallbackToSource = True, FileStorageLocation from = All);

Parameters

Name	Type	Description	Required	Default
path	`string`	Path	Required
fileName	`string`	File Name	Required
fallbackToSource	`bool`	Fallback To Source	Optional	True
from	`FileStorageLocation`	From	Optional	All

Return Type

Task<ICentralizedFile>

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

Parameters

Name	Type	Description	Required
path	`string`	Path	Required
searchOption	`PathSearchOption`	Search Option	Required
fallbackToSource	`bool`	Fallback To Source	Required

Return Type

IEnumerable<ICentralizedFile>

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

Parameters

Name	Type	Description	Required	Default	Options
path	`string`	Path	Required
searchOption	`PathSearchOption`	Search Option	Required

Return Type

IEnumerable<ICentralizedFile>

IEnumerable<ICentralizedFile> GetFiles(PathSearchOption searchOption);

Parameters

Name	Type	Description	Required	Default	Options
searchOption	`PathSearchOption`	Search Option	Required

Return Type

IEnumerable<ICentralizedFile>

Task<IEnumerable<ICentralizedFile>> GetFilesAsync(PathSearchOption searchOption);

Parameters

Name	Type	Description	Required	Default	Options
searchOption	`PathSearchOption`	Search Option	Required

Return Type

Task<IEnumerable<ICentralizedFile>>

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

Parameters

Name	Type	Description	Required
path	`string`	Path	Required
searchOption	`PathSearchOption`	Search Option	Required
fallbackToSource	`bool`	Fallback To Source	Required

Return Type

Task<IEnumerable<ICentralizedFile>>

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

Parameters

Name	Type	Description	Required	Default	Options
path	`string`	Path	Required
searchOption	`PathSearchOption`	Search Option	Required

Return Type

Task<IEnumerable<ICentralizedFile>>

IEnumerable<string> GetPaths(string path);

Parameters

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

Return Type

IEnumerable<string>

IEnumerable<string> GetPaths();

Return Type

IEnumerable<string>

Task<IEnumerable<string>> GetPathsAsync(string path);

Parameters

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

Return Type

Task<IEnumerable<string>>

Task<IEnumerable<string>> GetPathsAsync();

Return Type

Task<IEnumerable<string>>

Task<bool> HandleHttpRequestAsync(HttpContext context, ICentralizedFile file);

Parameters

Name	Type	Description	Required	Default	Options
context	`HttpContext`	Context	Required
file	`ICentralizedFile`	File	Required

Return Type

Task<bool>

void Initialize(string fileStoreKey, Dictionary<string,string> configuration);

Parameters

Name	Type	Description	Required	Default	Options
fileStoreKey	`string`	File Store Key	Required
configuration	`Dictionary<string,string>`	Configuration	Required

void RegisterMigrationSource(ICentralizedFileStorageProvider migrationSourcce, IMigratableCentralizedFileStorageProviderController controller);

Parameters

Name	Type	Description	Required	Default	Options
migrationSourcce	`ICentralizedFileStorageProvider`	Migration Sourcce	Required
controller	`IMigratableCentralizedFileStorageProviderController`	Controller	Required

Recommended