Interface IStorageServiceAsync

Namespace

InSite.Application.Files.Read

Assembly

Shift.Sdk.dll

public interface IStorageServiceAsync

Extension Methods

ExceptionExtensions.FromHierarchy<TSource>(TSource, Func<TSource, TSource>)

ExceptionExtensions.FromHierarchy<TSource>(TSource, Func<TSource, TSource>, Func<TSource, bool>)

ObjectCopier.CloneJson<T>(T)

ObjectCopier.ShallowCopyTo<TSource, TDestination>(TSource, TDestination, BindingFlags)

Methods

ChangeClaimsAsync(Guid, IEnumerable<FileClaim>)

Task ChangeClaimsAsync(Guid fileIdentifier, IEnumerable<FileClaim> claims)

Parameters

fileIdentifier Guid

claims IEnumerable<FileClaim>

Returns

Task

ChangeObjectAsync(Guid, Guid, FileObjectType)

Task ChangeObjectAsync(Guid fileIdentifier, Guid objectIdentifier, FileObjectType objectType)

Parameters

fileIdentifier Guid

objectIdentifier Guid

objectType FileObjectType

Returns

Task

ChangePropertiesAsync(Guid, Guid, FileProperties, bool)

Task ChangePropertiesAsync(Guid fileIdentifier, Guid userIdentifier, FileProperties properties, bool updateActivityChanges)

Parameters

fileIdentifier Guid

userIdentifier Guid

properties FileProperties

updateActivityChanges bool

Returns

Task

ClearCache()

void ClearCache()

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

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

Parameters

file Stream

fileName string

organizationIdentifier Guid

actorUserIdentifier Guid

objectIdentifier Guid

objectType FileObjectType

properties FileProperties

claims IEnumerable<FileClaim>

fileLocation FileLocation

filePath string

Returns

Task<FileStorageModel>

DeleteAsync(Guid)

Task DeleteAsync(Guid fileIdentifier)

Parameters

fileIdentifier Guid

Returns

Task

DeleteExpiredFilesAsync()

Task<int> DeleteExpiredFilesAsync()

Returns

Task<int>

DeleteOnlyRecordAsync(Guid)

Task DeleteOnlyRecordAsync(Guid fileIdentifier)

Parameters

fileIdentifier Guid

Returns

Task

GetFileAndAuthorizeAsync(ISimplePrincipal, Guid)

Task<(FileGrantStatus, FileStorageModel)> GetFileAndAuthorizeAsync(ISimplePrincipal identity, Guid fileIdentifier)

Parameters

identity ISimplePrincipal

fileIdentifier Guid

Returns

Task<(FileGrantStatus, FileStorageModel)>

GetFileAsync(Guid)

Task<FileStorageModel> GetFileAsync(Guid fileIdentifier)

Parameters

fileIdentifier Guid

Returns

Task<FileStorageModel>

GetFileStreamAndAuthorizeAsync(ISimplePrincipal, Guid)

Task<(FileGrantStatus, FileStorageModel, Stream)> GetFileStreamAndAuthorizeAsync(ISimplePrincipal identity, Guid fileIdentifier)

Parameters

identity ISimplePrincipal

fileIdentifier Guid

Returns

Task<(FileGrantStatus, FileStorageModel, Stream)>

GetFileStreamAsync(Guid)

Task<(FileStorageModel, Stream)> GetFileStreamAsync(Guid fileIdentifier)

Parameters

fileIdentifier Guid

Returns

Task<(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

GetGrantStatusAsync(ISimplePrincipal, Guid)

Task<FileGrantStatus> GetGrantStatusAsync(ISimplePrincipal identity, Guid fileIdentifier)

Parameters

identity ISimplePrincipal

fileIdentifier Guid

Returns

Task<FileGrantStatus>

GetGrantedFilesAsync(ISimplePrincipal, Guid, string)

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

Parameters

identity ISimplePrincipal

objectIdentifier Guid

documentName string

Returns

Task<List<FileStorageModel>>

GetGrantedFilesAsync(ISimplePrincipal, Guid[], string)

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

Parameters

identity ISimplePrincipal

objectIdentifiers Guid[]

documentName string

Returns

Task<List<FileStorageModel>>

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)

RenameFileAsync(Guid, Guid, string)

Task RenameFileAsync(Guid fileIdentifier, Guid userIdentifier, string newFileName)

Parameters

fileIdentifier Guid

userIdentifier Guid

newFileName string

Returns

Task