Table of Contents

Interface IStorageService

Namespace
InSite.Application.Files.Read
Assembly
Shift.Sdk.dll
public interface IStorageService
Extension Methods

Methods

AdjustFileName(string)

string AdjustFileName(string fileName)

Parameters

fileName string

Returns

string

ChangeClaims(Guid, IEnumerable<FileClaim>)

void ChangeClaims(Guid fileIdentifier, IEnumerable<FileClaim> claims)

Parameters

fileIdentifier Guid
claims IEnumerable<FileClaim>

ChangeObject(Guid, Guid, FileObjectType)

void ChangeObject(Guid fileIdentifier, Guid objectIdentifier, FileObjectType objectType)

Parameters

fileIdentifier Guid
objectIdentifier Guid
objectType FileObjectType

ChangeProperties(Guid, Guid, FileProperties, bool)

void ChangeProperties(Guid fileIdentifier, Guid changedByUserIdentifier, FileProperties properties, bool updateActivityChanges)

Parameters

fileIdentifier Guid
changedByUserIdentifier Guid
properties FileProperties
updateActivityChanges bool

ClearCache()

void ClearCache()

Create(Stream, string, Guid, Guid, Guid, FileObjectType, FileProperties, IEnumerable<FileClaim>, FileLocation, string)

FileStorageModel Create(Stream file, string fileName, Guid organizationIdentifier, Guid actorUserIdentifier, Guid objectIdentifier, FileObjectType objectType, FileProperties props, IEnumerable<FileClaim> claims, FileLocation fileLocation = FileLocation.Local, string filePath = null)

Parameters

file Stream
fileName string
organizationIdentifier Guid
actorUserIdentifier Guid
objectIdentifier Guid
objectType FileObjectType
props FileProperties
claims IEnumerable<FileClaim>
fileLocation FileLocation
filePath string

Returns

FileStorageModel

Delete(Guid)

void Delete(Guid fileIdentifier)

Parameters

fileIdentifier Guid

DeleteExpiredFiles()

int DeleteExpiredFiles()

Returns

int

DeleteOnlyRecord(Guid)

void DeleteOnlyRecord(Guid fileIdentifier)

Parameters

fileIdentifier Guid

GetFile(Guid)

FileStorageModel GetFile(Guid fileIdentifier)

Parameters

fileIdentifier Guid

Returns

FileStorageModel

GetFileAndAuthorize(ISimplePrincipal, Guid)

(FileGrantStatus, FileStorageModel) GetFileAndAuthorize(ISimplePrincipal identity, Guid fileIdentifier)

Parameters

identity ISimplePrincipal
fileIdentifier Guid

Returns

(FileGrantStatus, FileStorageModel)

GetFileStream(Guid)

(FileStorageModel, Stream) GetFileStream(Guid fileIdentifier)

Parameters

fileIdentifier Guid

Returns

(FileStorageModel, Stream)

GetFileStreamAndAuthorize(ISimplePrincipal, Guid)

(FileGrantStatus, FileStorageModel, Stream) GetFileStreamAndAuthorize(ISimplePrincipal identity, Guid fileIdentifier)

Parameters

identity ISimplePrincipal
fileIdentifier Guid

Returns

(FileGrantStatus, FileStorageModel, Stream)

GetFileUrl(FileStorageModel, bool)

string GetFileUrl(FileStorageModel model, bool download = false)

Parameters

model FileStorageModel
download bool

Returns

string

GetFileUrl(Guid, string, bool)

string GetFileUrl(Guid fileIdentifier, string fileName, bool download = false)

Parameters

fileIdentifier Guid
fileName string
download bool

Returns

string

GetGrantStatus(ISimplePrincipal, Guid)

FileGrantStatus GetGrantStatus(ISimplePrincipal identity, Guid fileIdentifier)

Parameters

identity ISimplePrincipal
fileIdentifier Guid

Returns

FileGrantStatus

GetGrantedFiles(ISimplePrincipal, Guid, string)

List<FileStorageModel> GetGrantedFiles(ISimplePrincipal identity, Guid objectIdentifier, string documentName = null)

Parameters

identity ISimplePrincipal
objectIdentifier Guid
documentName string

Returns

List<FileStorageModel>

GetGrantedFiles(ISimplePrincipal, Guid[], string)

List<FileStorageModel> GetGrantedFiles(ISimplePrincipal identity, Guid[] objectIdentifiers, string documentName = null)

Parameters

identity ISimplePrincipal
objectIdentifiers Guid[]
documentName string

Returns

List<FileStorageModel>

IsFileExist(Guid)

bool IsFileExist(Guid fileIdentifier)

Parameters

fileIdentifier Guid

Returns

bool

IsRemoteFilePathValid(FileStorageModel)

bool IsRemoteFilePathValid(FileStorageModel file)

Parameters

file FileStorageModel

Returns

bool

ParseFileUrl(string)

(Guid? FileIdentifier, string FileName) ParseFileUrl(string fileUrl)

Parameters

fileUrl string

Returns

(Guid? FileIdentifier, string FileName)

ParseSurveyResponseAnswer(string)

List<(Guid FileIdentifier, string FileName)> ParseSurveyResponseAnswer(string responseAnswerText)

Parameters

responseAnswerText string

Returns

List<(Guid FileIdentifier, string FileName)>

RenameFile(Guid, Guid, string)

void RenameFile(Guid fileIdentifier, Guid userIdentifier, string newFileName)

Parameters

fileIdentifier Guid
userIdentifier Guid
newFileName string