PrivMX DOCS
API Reference/PrivMX Endpoint C# Extra/Inboxes

InboxApiExtensions

Static Methods

GetInboxAsync

Params

inboxApi

this IInboxApi

inboxId

string

token

CancellationToken

static ValueTask<PrivMX.Endpoint.Inbox.Models.Inbox> GetInboxAsync(
this IInboxApi inboxApi,
string inboxId,
CancellationToken token = default
)

Returns

ValueTask<PrivMX.Endpoint.Inbox.Models.Inbox> ·

CreateInboxAsync

Params

inboxApi

this IInboxApi

contextId

string

users

List<UserWithPubKey>

managers

List<UserWithPubKey>

publicMeta

byte[]

privateMeta

byte[]

filesConfig

FilesConfig

policies

ContainerPolicyWithoutItem?

token

CancellationToken

static ValueTask<string> CreateInboxAsync(
this IInboxApi inboxApi,
string contextId,
List<UserWithPubKey> users,
List<UserWithPubKey> managers,
byte[] publicMeta,
byte[] privateMeta,
FilesConfig filesConfig,
ContainerPolicyWithoutItem? policies = null,
CancellationToken token = default
)

Returns

ValueTask<string> ·

UpdateInboxAsync

Params

inboxApi

this IInboxApi

inboxId

string

users

List<UserWithPubKey>

managers

List<UserWithPubKey>

publicMeta

byte[]

privateMeta

byte[]

filesConfig

FilesConfig

version

long

force

bool

forceGenerateNewKey

bool

policies

ContainerPolicyWithoutItem?

token

CancellationToken

static ValueTask UpdateInboxAsync(
this IInboxApi inboxApi,
string inboxId,
List<UserWithPubKey> users,
List<UserWithPubKey> managers,
byte[] publicMeta,
byte[] privateMeta,
FilesConfig filesConfig,
long version,
bool force,
bool forceGenerateNewKey,
ContainerPolicyWithoutItem? policies = null,
CancellationToken token = default
)

Returns

ValueTask ·

ListInboxesAsync

Params

inboxApi

this IInboxApi

contextId

string

pagingQuery

PagingQuery

token

CancellationToken

static ValueTask<PagingList<PrivMX.Endpoint.Inbox.Models.Inbox>> ListInboxesAsync(
this IInboxApi inboxApi,
string contextId,
PagingQuery pagingQuery,
CancellationToken token = default
)

Returns

ValueTask<PagingList<PrivMX.Endpoint.Inbox.Models.Inbox>> ·

GetInboxPublicViewAsync

Params

inboxApi

this IInboxApi

inboxId

string

token

CancellationToken

static ValueTask<InboxPublicView> GetInboxPublicViewAsync(
this IInboxApi inboxApi,
string inboxId,
CancellationToken token = default
)

Returns

ValueTask<InboxPublicView> ·

DeleteInboxAsync

Params

inboxApi

this IInboxApi

inboxId

string

token

CancellationToken

static ValueTask DeleteInboxAsync(
this IInboxApi inboxApi,
string inboxId,
CancellationToken token = default
)

Returns

ValueTask ·

PrepareEntryAsync

Params

inboxApi

this IInboxApi

inboxId

string

data

byte[]

inboxFileHandles

List<long>

userPrivKey

string

token

CancellationToken

static ValueTask<long> PrepareEntryAsync(
this IInboxApi inboxApi,
string inboxId,
byte[] data,
List<long> inboxFileHandles,
string userPrivKey,
CancellationToken token = default
)

Returns

ValueTask<long> ·

SendEntryAsync

Params

inboxApi

this IInboxApi

inboxHandle

long

token

CancellationToken

static ValueTask SendEntryAsync(
this IInboxApi inboxApi,
long inboxHandle,
CancellationToken token = default
)

Returns

ValueTask ·

ReadEntryAsync

Params

inboxApi

this IInboxApi

inboxEntryId

string

token

CancellationToken

static ValueTask<InboxEntry> ReadEntryAsync(
this IInboxApi inboxApi,
string inboxEntryId,
CancellationToken token = default
)

Returns

ValueTask<InboxEntry> ·

ListEntriesAsync

Params

inboxApi

this IInboxApi

inboxId

string

pagingQuery

PagingQuery

token

CancellationToken

static ValueTask<PagingList<InboxEntry>> ListEntriesAsync(
this IInboxApi inboxApi,
string inboxId,
PagingQuery pagingQuery,
CancellationToken token = default
)

Returns

ValueTask<PagingList<InboxEntry>> ·

DeleteEntryAsync

Params

inboxApi

this IInboxApi

inboxEntryId

string

token

CancellationToken

static ValueTask DeleteEntryAsync(
this IInboxApi inboxApi,
string inboxEntryId,
CancellationToken token = default
)

Returns

ValueTask ·

CreateFileHandleAsync

Params

inboxApi

this IInboxApi

publicMeta

byte[]

privateMeta

byte[]

fileSize

long

token

CancellationToken

static ValueTask<long> CreateFileHandleAsync(
this IInboxApi inboxApi,
byte[] publicMeta,
byte[] privateMeta,
long fileSize,
CancellationToken token = default
)

Returns

ValueTask<long> ·

WriteToFileAsync

Params

inboxApi

this IInboxApi

inboxHandle

long

inboxFileHandle

long

dataChunk

byte[]

token

CancellationToken

static ValueTask WriteToFileAsync(
this IInboxApi inboxApi,
long inboxHandle,
long inboxFileHandle,
byte[] dataChunk,
CancellationToken token = default
)

Returns

ValueTask ·

OpenFileAsync

Params

inboxApi

this IInboxApi

fileId

string

token

CancellationToken

static ValueTask<long> OpenFileAsync(
this IInboxApi inboxApi,
string fileId,
CancellationToken token = default
)

Returns

ValueTask<long> ·

ReadFromFileAsync

Params

inboxApi

this IInboxApi

fileHandle

long

length

long

token

CancellationToken

static ValueTask<byte[]> ReadFromFileAsync(
this IInboxApi inboxApi,
long fileHandle,
long length,
CancellationToken token = default
)

Returns

ValueTask<byte[]> ·

SeekInFileAsync

Params

inboxApi

this IInboxApi

fileHandle

long

position

long

token

CancellationToken

static ValueTask SeekInFileAsync(
this IInboxApi inboxApi,
long fileHandle,
long position,
CancellationToken token = default
)

Returns

ValueTask ·

CloseFileAsync

Params

inboxApi

this IInboxApi

fileHandle

long

token

CancellationToken

static ValueTask<string> CloseFileAsync(
this IInboxApi inboxApi,
long fileHandle,
CancellationToken token = default
)

Returns

ValueTask<string> ·

SubscribeForInboxEventsAsync

Params

inboxApi

this IInboxApi

token

CancellationToken

static ValueTask SubscribeForInboxEventsAsync(
this IInboxApi inboxApi,
CancellationToken token = default
)

Returns

ValueTask ·

UnsubscribeFromInboxEventsAsync

Params

inboxApi

this IInboxApi

token

CancellationToken

static ValueTask UnsubscribeFromInboxEventsAsync(
this IInboxApi inboxApi,
CancellationToken token = default
)

Returns

ValueTask ·

SubscribeForEntryEventsAsync

Params

inboxApi

this IInboxApi

inboxId

string

token

CancellationToken

static ValueTask SubscribeForEntryEventsAsync(
this IInboxApi inboxApi,
string inboxId,
CancellationToken token = default
)

Returns

ValueTask ·

UnsubscribeFromEntryEventsAsync

Params

inboxApi

this IInboxApi

inboxId

string

token

CancellationToken

static ValueTask UnsubscribeFromEntryEventsAsync(
this IInboxApi inboxApi,
string inboxId,
CancellationToken token = default
)

Returns

ValueTask ·

We use cookies on our website. We use them to ensure the proper functioning of the site and, if you agree, for purposes we set, such as analytics or marketing.