Interface IInboxApi

Namespace

PrivMX.Endpoint.Inbox

Assembly

PrivMX.Endpoint.dll

public interface IInboxApi

Methods

CloseFile(long)

string CloseFile(long fileHandle)

Parameters

fileHandle long

Returns

string

CreateFileHandle(byte[], byte[], long)

long CreateFileHandle(byte[] publicMeta, byte[] privateMeta, long fileSize)

Parameters

publicMeta byte[]

privateMeta byte[]

fileSize long

Returns

long

CreateInbox(string, List<UserWithPubKey>, List<UserWithPubKey>, byte[], byte[], FilesConfig?, ContainerPolicyWithoutItem?)

string CreateInbox(string contextId, List<UserWithPubKey> users, List<UserWithPubKey> managers, byte[] publicMeta, byte[] privateMeta, FilesConfig? filesConfig, ContainerPolicyWithoutItem? policies = null)

Parameters

contextId string

users List<UserWithPubKey>

managers List<UserWithPubKey>

publicMeta byte[]

privateMeta byte[]

filesConfig FilesConfig

policies ContainerPolicyWithoutItem

Returns

string

DeleteEntry(string)

void DeleteEntry(string inboxEntryId)

Parameters

inboxEntryId string

DeleteInbox(string)

void DeleteInbox(string inboxId)

Parameters

inboxId string

GetInbox(string)

Inbox GetInbox(string inboxId)

Parameters

inboxId string

Returns

Inbox

GetInboxPublicView(string)

InboxPublicView GetInboxPublicView(string inboxId)

Parameters

inboxId string

Returns

InboxPublicView

ListEntries(string, PagingQuery)

PagingList<InboxEntry> ListEntries(string inboxId, PagingQuery pagingQuery)

Parameters

inboxId string

pagingQuery PagingQuery

Returns

PagingList<InboxEntry>

ListInboxes(string, PagingQuery)

PagingList<Inbox> ListInboxes(string contextId, PagingQuery pagingQuery)

Parameters

contextId string

pagingQuery PagingQuery

Returns

PagingList<Inbox>

OpenFile(string)

long OpenFile(string fileId)

Parameters

fileId string

Returns

long

PrepareEntry(string, byte[], List<long>, byte[]?)

long PrepareEntry(string inboxId, byte[] data, List<long> inboxFileHandles, byte[]? userPrivKey)

Parameters

inboxId string

data byte[]

inboxFileHandles List<long>

userPrivKey byte[]

Returns

long

ReadEntry(string)

InboxEntry ReadEntry(string inboxEntryId)

Parameters

inboxEntryId string

Returns

InboxEntry

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

SendEntry(long)

void SendEntry(long inboxHandle)

Parameters

inboxHandle long

SubscribeForEntryEvents(string)

void SubscribeForEntryEvents(string inboxId)

Parameters

inboxId string

SubscribeForInboxEvents()

void SubscribeForInboxEvents()

UnsubscribeFromEntryEvents(string)

void UnsubscribeFromEntryEvents(string inboxId)

Parameters

inboxId string

UnsubscribeFromInboxEvents()

void UnsubscribeFromInboxEvents()

UpdateInbox(string, List<UserWithPubKey>, List<UserWithPubKey>, byte[], byte[], FilesConfig?, long, bool, bool, ContainerPolicyWithoutItem?)

void UpdateInbox(string inboxId, List<UserWithPubKey> users, List<UserWithPubKey> managers, byte[] publicMeta, byte[] privateMeta, FilesConfig? filesConfig, long version, bool force, bool forceGenerateNewKey, ContainerPolicyWithoutItem? policies = null)

Parameters

inboxId string

users List<UserWithPubKey>

managers List<UserWithPubKey>

publicMeta byte[]

privateMeta byte[]

filesConfig FilesConfig

version long

force bool

forceGenerateNewKey bool

policies ContainerPolicyWithoutItem

WriteToFile(long, long, byte[])

void WriteToFile(long inboxHandle, long inboxFileHandle, byte[] dataChunk)

Parameters

inboxHandle long

inboxFileHandle long

dataChunk byte[]