Interface IStoreApi

Namespace

PrivMX.Endpoint.Store

Assembly

PrivMX.Endpoint.dll

public interface IStoreApi

Methods

CloseFile(long)

string CloseFile(long fileHandle)

Parameters

fileHandle long

Returns

string

CreateFile(string, byte[], byte[], long)

long CreateFile(string storeId, byte[] publicMeta, byte[] privateMeta, long size)

Parameters

storeId string

publicMeta byte[]

privateMeta byte[]

size long

Returns

long

CreateStore(string, List<UserWithPubKey>, List<UserWithPubKey>, byte[], byte[], ContainerPolicy?)

string CreateStore(string contextId, List<UserWithPubKey> users, List<UserWithPubKey> managers, byte[] publicMeta, byte[] privateMeta, ContainerPolicy? policies = null)

Parameters

contextId string

users List<UserWithPubKey>

managers List<UserWithPubKey>

publicMeta byte[]

privateMeta byte[]

policies ContainerPolicy

Returns

string

DeleteFile(string)

void DeleteFile(string storeId)

Parameters

storeId string

DeleteStore(string)

void DeleteStore(string storeId)

Parameters

storeId string

GetFile(string)

File GetFile(string fileId)

Parameters

fileId string

Returns

File

GetStore(string)

Store GetStore(string storeId)

Parameters

storeId string

Returns

Store

ListFiles(string, PagingQuery)

PagingList<File> ListFiles(string storeId, PagingQuery pagingQuery)

Parameters

storeId string

pagingQuery PagingQuery

Returns

PagingList<File>

ListStores(string, PagingQuery)

PagingList<Store> ListStores(string contextId, PagingQuery pagingQuery)

Parameters

contextId string

pagingQuery PagingQuery

Returns

PagingList<Store>

OpenFile(string)

long OpenFile(string fileId)

Parameters

fileId string

Returns

long

ReadFromFile(long, long)

byte[] ReadFromFile(long fileHandle, long length)

Parameters

fileHandle long

length long

Returns

byte[]

SeekInFile(long, long)

void SeekInFile(long fileHandle, long position)

Parameters

fileHandle long

position long

SubscribeForFileEvents(string)

void SubscribeForFileEvents(string storeId)

Parameters

storeId string

SubscribeForStoreEvents()

void SubscribeForStoreEvents()

UnsubscribeFromFileEvents(string)

void UnsubscribeFromFileEvents(string storeId)

Parameters

storeId string

UnsubscribeFromStoreEvents()

void UnsubscribeFromStoreEvents()

UpdateFile(string, byte[], byte[], long)

long UpdateFile(string fileId, byte[] publicMeta, byte[] privateMeta, long size)

Parameters

fileId string

publicMeta byte[]

privateMeta byte[]

size long

Returns

long

UpdateFileMeta(string, byte[], byte[])

void UpdateFileMeta(string fileId, byte[] publicMeta, byte[] privateMeta)

Parameters

fileId string

publicMeta byte[]

privateMeta byte[]

UpdateStore(string, List<UserWithPubKey>, List<UserWithPubKey>, byte[], byte[], long, bool, bool, ContainerPolicy?)

void UpdateStore(string storeId, List<UserWithPubKey> users, List<UserWithPubKey> managers, byte[] publicMeta, byte[] privateMeta, long version, bool force, bool forceGenerateNewKey, ContainerPolicy? policies = null)

Parameters

storeId string

users List<UserWithPubKey>

managers List<UserWithPubKey>

publicMeta byte[]

privateMeta byte[]

version long

force bool

forceGenerateNewKey bool

policies ContainerPolicy

WriteToFile(long, byte[])

void WriteToFile(long fileHandle, byte[] dataChunk)

Parameters

fileHandle long

dataChunk byte[]