CentralizedFileStorage In-Process API Service

This service is available via Telligent.Evolution.Extensibility.Storage.Version1.CentralizedFileStorage

Events

Events.AfterCreate

Handler

void CentralizedFileAfterCreateEventHandler(CentralizedFileAfterCreateEventArgs e);

Events.AfterDelete

Handler

void CentralizedFileAfterDeleteEventHandler(CentralizedFileAfterDeleteEventArgs e);

Events.AfterUpdate

Handler

void CentralizedFileAfterUpdateEventHandler(CentralizedFileAfterUpdateEventArgs e);

Events.BeforeCreate

Handler

void CentralizedFileBeforeCreateEventHandler(CentralizedFileBeforeCreateEventArgs e);

Events.BeforeDelete

Handler

void CentralizedFileBeforeDeleteEventHandler(CentralizedFileBeforeDeleteEventArgs e);

Events.BeforeUpdate

Handler

void CentralizedFileBeforeUpdateEventHandler(CentralizedFileBeforeUpdateEventArgs e);

Events.GetClientDownloadUrl

Handler

void CentralizedFileGetClientDownloadUrlEventHandler(CentralizedFileGetClientDownloadUrlEventArgs e);

Properties

Name	Type	Description	Default	Options
DirectorySeparator	`Char`
ValidFileNameRegexPattern	`string`
ValidFileStoreKeyRegexPattern	`string`
ValidPathRegexPattern	`string`

Methods

bool AccessingUserHasAccess(string fileStoreKey, string path, string fileName);

Parameters

Name	Type	Description	Required
fileStoreKey	`string`	File Store Key	Required
path	`string`	Path	Required
fileName	`string`	File Name	Required

Return Type

bool

Task<bool> AccessingUserHasAccessAsync(string fileStoreKey, string path, string fileName);

Parameters

Name	Type	Description	Required
fileStoreKey	`string`	File Store Key	Required
path	`string`	Path	Required
fileName	`string`	File Name	Required

Return Type

Task<bool>

bool EveryoneHasAccess(string fileStoreKey, string path, string fileName);

Parameters

Name	Type	Description	Required
fileStoreKey	`string`	File Store Key	Required
path	`string`	Path	Required
fileName	`string`	File Name	Required

Return Type

bool

Task<bool> EveryoneHasAccessAsync(string fileStoreKey, string path, string fileName);

Parameters

Name	Type	Description	Required
fileStoreKey	`string`	File Store Key	Required
path	`string`	Path	Required
fileName	`string`	File Name	Required

Return Type

Task<bool>

CentralizedFile FindFile(string fileStoreKey, string path, string fileName);

Parameters

Name	Type	Description	Required
fileStoreKey	`string`	File Store Key	Required
path	`string`	Path	Required
fileName	`string`	File Name	Required

Return Type

CentralizedFile

Task<CentralizedFile> FindFileAsync(string fileStoreKey, string path, string fileName);

Parameters

Name	Type	Description	Required
fileStoreKey	`string`	File Store Key	Required
path	`string`	Path	Required
fileName	`string`	File Name	Required

Return Type

Task<CentralizedFile>

CentralizedFile GetCentralizedFileByUrl(string url);

Parameters

Name	Type	Description	Required	Default	Options
url	`string`	Url	Required

Return Type

CentralizedFile

Task<CentralizedFile> GetCentralizedFileByUrlAsync(string url);

Parameters

Name	Type	Description	Required	Default	Options
url	`string`	Url	Required

Return Type

Task<CentralizedFile>

string GetClientDownloadUrl(CentralizedFile file);

Parameters

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

Return Type

string

string GetDeliveryUrl(CentralizedFile file);

Parameters

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

Return Type

string

Task<string> GetDeliveryUrlAsync(CentralizedFile file);

Parameters

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

Return Type

Task<string>

CentralizedFileStore GetFileStore(string fileStoreKey);

Parameters

Name	Type	Description	Required	Default	Options
fileStoreKey	`string`	File Store Key	Required

Return Type

CentralizedFileStore

IEnumerable<string> GetFileStoreKeys();

Return Type

IEnumerable<string>

string GetGenericUrl(CentralizedFile file);

Parameters

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

Return Type

string

string GetGenericUrl(string fileStoreKey, string path, string fileName, string versionKey);

Parameters

Name	Type	Description	Required
fileStoreKey	`string`	File Store Key	Required
path	`string`	Path	Required
fileName	`string`	File Name	Required
versionKey	`string`	Version Key	Required

Return Type

string

string GetUniqueFileName(string fileStoreKey, string path, string fileName);

Parameters

Name	Type	Description	Required
fileStoreKey	`string`	File Store Key	Required
path	`string`	Path	Required
fileName	`string`	File Name	Required

Return Type

string

Task<string> GetUniqueFileNameAsync(string fileStoreKey, string path, string fileName);

Parameters

Name	Type	Description	Required
fileStoreKey	`string`	File Store Key	Required
path	`string`	Path	Required
fileName	`string`	File Name	Required

Return Type

Task<string>

bool HasAccessValidator(string fileStoreKey);

Parameters

Name	Type	Description	Required	Default	Options
fileStoreKey	`string`	File Store Key	Required

Return Type

bool

bool HasFileFinder(string fileStoreKey);

Parameters

Name	Type	Description	Required	Default	Options
fileStoreKey	`string`	File Store Key	Required

Return Type

bool

bool IsCentralizedFileUrl(string url);

Parameters

Name	Type	Description	Required	Default	Options
url	`string`	Url	Required

Return Type

bool

bool IsValid(string fileStoreKey, string path, string fileName);

Parameters

Name	Type	Description	Required
fileStoreKey	`string`	File Store Key	Required
path	`string`	Path	Required
fileName	`string`	File Name	Required

Return Type

bool

bool IsValidFileName(string fileName);

Parameters

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

Return Type

bool

bool IsValidFileStoreKey(string fileStoreKey);

Parameters

Name	Type	Description	Required	Default	Options
fileStoreKey	`string`	File Store Key	Required

Return Type

bool

bool IsValidPath(string path);

Parameters

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

Return Type

bool

string MakePath(IEnumerable<string> pathComponents);

Parameters

Name	Type	Description	Required	Default	Options
pathComponents	`IEnumerable<string>`	Path Components	Required

Return Type

string

string MakePath(params string[] pathComponents);

Parameters

Name	Type	Description	Required	Default	Options
pathComponents	`string[]`	Path Components	Required

Return Type

string

bool UserHasAccess(string fileStoreKey, string path, string fileName, int userId);

Parameters

Name	Type	Description	Required
fileStoreKey	`string`	File Store Key	Required
path	`string`	Path	Required
fileName	`string`	File Name	Required
userId	`int`	User Id	Required

Return Type

bool

Task<bool> UserHasAccessAsync(string fileStoreKey, string path, string fileName, int userId);

Parameters

Name	Type	Description	Required
fileStoreKey	`string`	File Store Key	Required
path	`string`	Path	Required
fileName	`string`	File Name	Required
userId	`int`	User Id	Required

Return Type

Task<bool>

Recommended