CentralizedFileStorage In-Process API Service

Former Member — Fri, 13 May 2022 19:30:05 GMT

Current Revision posted to API Documentation by Former Member on 05/13/2022 19:30:05

This service is available via Telligent.Evolution.Extensibility.Storage.Version1.CentralizedFileStorage and is defined in Telligent.Evolution.Platform.dll

Events

Events.AfterCreate

Handler

void CentralizedFileAfterCreateEventHandler([[CentralizedFileAfterCreateEventArgs In-Process API Event Argument|CentralizedFileAfterCreateEventArgs]] e);

Events.AfterDelete

Handler

void CentralizedFileAfterDeleteEventHandler([[CentralizedFileAfterDeleteEventArgs In-Process API Event Argument|CentralizedFileAfterDeleteEventArgs]] e);

Events.AfterDownload

Handler

void CentralizedFileAfterDownloadEventHandler([[CentralizedFileAfterDownloadEventArgs In-Process API Event Argument|CentralizedFileAfterDownloadEventArgs]] e);

Events.AfterUpdate

Handler

void CentralizedFileAfterUpdateEventHandler([[CentralizedFileAfterUpdateEventArgs In-Process API Event Argument|CentralizedFileAfterUpdateEventArgs]] e);

Events.BeforeCreate

Handler

void CentralizedFileBeforeCreateEventHandler([[CentralizedFileBeforeCreateEventArgs In-Process API Event Argument|CentralizedFileBeforeCreateEventArgs]] e);

Events.BeforeDelete

Handler

void CentralizedFileBeforeDeleteEventHandler([[CentralizedFileBeforeDeleteEventArgs In-Process API Event Argument|CentralizedFileBeforeDeleteEventArgs]] e);

Events.BeforeDownload

Handler

void CentralizedFileBeforeDownloadEventHandler([[CentralizedFileBeforeDownloadEventArgs In-Process API Event Argument|CentralizedFileBeforeDownloadEventArgs]] e);

Events.BeforeUpdate

Handler

void CentralizedFileBeforeUpdateEventHandler([[CentralizedFileBeforeUpdateEventArgs In-Process API Event Argument|CentralizedFileBeforeUpdateEventArgs]] e);

Events.GetClientDownloadUrl

Handler

void CentralizedFileGetClientDownloadUrlEventHandler([[CentralizedFileGetClientDownloadUrlEventArgs In-Process API Event Argument|CentralizedFileGetClientDownloadUrlEventArgs]] e);

Properties

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

Methods

bool AccessValidationIsGlobal(string fileStoreKey);

Parameters

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

Return Type

bool

bool CurrentUserHasAccess(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 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

bool FindFile(ref string fileStoreKey, ref string path, ref string fileName);

Parameters

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

Return Type

bool

ICentralizedFile GetCentralizedFileByUrl(string url);

Parameters

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

Return Type

[[ICentralizedFile In-Process API Supplementary Type|ICentralizedFile]]

string GetClientDownloadUrl(ICentralizedFile file);

Parameters

Name	Type	Description	Required	Default	Options
file	`[[ICentralizedFile In-Process API Supplementary Type\|ICentralizedFile]]`	File	Required

Return Type

string

string GetDeliveryUrl(ICentralizedFile file);

Parameters

Name	Type	Description	Required	Default	Options
file	`[[ICentralizedFile In-Process API Supplementary Type\|ICentralizedFile]]`	File	Required

Return Type

string

ICentralizedFileStorageProvider GetFileStore(string fileStoreKey);

Parameters

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

Return Type

[[ICentralizedFileStorageProvider In-Process API Supplementary Type|ICentralizedFileStorageProvider]]

IEnumerable<string> GetFileStoreKeys();

Return Type

IEnumerable<string>

string GetGenericDownloadUrl(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

string GetGenericDownloadUrl(ICentralizedFile file);

Parameters

Name	Type	Description	Required	Default	Options
file	`[[ICentralizedFile In-Process API Supplementary Type\|ICentralizedFile]]`	File	Required

Return Type

string

string GetPersistentDownloadUrl(string genericDownloadUrl);

Parameters

Name	Type	Description	Required	Default	Options
genericDownloadUrl	`string`	Generic Download Url	Required

Return Type

string

string GetPersistentDownloadUrl(ICentralizedFile file);

Parameters

Name	Type	Description	Required	Default	Options
file	`[[ICentralizedFile In-Process API Supplementary Type\|ICentralizedFile]]`	File	Required

Return Type

string

string GetUniqueFileName(ICentralizedFileStorageProvider provider, string path, string fileName);

Parameters

Name	Type	Description	Required
provider	`[[ICentralizedFileStorageProvider In-Process API Supplementary Type\|ICentralizedFileStorageProvider]]`	Provider	Required
path	`string`	Path	Required
fileName	`string`	File Name	Required

Return Type

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 HasVersionKey(string url);

Parameters

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

Return Type

bool

ICentralizedFileStorageProvider Instance(string fileStoreKey);

Obsolete. Use GetFileStore(string) instead.

Parameters

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

Return Type

[[ICentralizedFileStorageProvider In-Process API Supplementary Type|ICentralizedFileStorageProvider]]

bool IsCentralizedFileUrl(string url);

Parameters

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

Return Type

bool

bool IsDeliverable(ICentralizedFile file);

Parameters

Name	Type	Description	Required	Default	Options
file	`[[ICentralizedFile In-Process API Supplementary Type\|ICentralizedFile]]`	File	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 TryGetCentralizedFileByUrl(string url, out ref ICentralizedFile file);

Parameters

Name	Type	Description	Required	Default	Options
url	`string`	Url	Required
file	`ref [[ICentralizedFile In-Process API Supplementary Type\|ICentralizedFile]]`	File	Required

Return Type

bool

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