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

Models

InboxReadFileStream

public class InboxReadFileStream : PrivmxEndpointCsharpExtra.Abstractions.PrivmxFileStream
{
    override? string FileId {get; set;}
    override ReadOnlySpan<byte> PublicMeta {get; set;}
    override ReadOnlySpan<byte> PrivateMeta {get; set;}
    override bool CanRead {get; set;}
    override bool CanSeek {get; set;}
    override bool CanWrite {get; set;}
    override long Length {get; set;}
    override long Position {get; set;}
}

Fields

FileId

override? string

PublicMeta

override ReadOnlySpan<byte>

PrivateMeta

override ReadOnlySpan<byte>

CanRead

override bool

Returns if current stream supports reading.

CanSeek

override bool

Returns if current stream supports seeking.

CanWrite

override bool

Returns if current stream supports writing.

Length

override long

Returns total length of the stream.

Position

override long

Sets or gets the position with the stream.

InboxWriteFileStream

public class InboxWriteFileStream : PrivmxEndpointCsharpExtra.Abstractions.PrivmxFileStream
{
    override? string FileId {get; set;}
    override ReadOnlySpan<byte> PublicMeta {get; set;}
    override ReadOnlySpan<byte> PrivateMeta {get; set;}
    override bool CanRead {get; set;}
    override bool CanSeek {get; set;}
    override bool CanWrite {get; set;}
    override long Length {get; set;}
    override long Position {get; set;}
}

Fields

FileId

override? string

File ID. May be null if file is not yet created. May change after object disposal when the file is closed and saved on the server.

PublicMeta

override ReadOnlySpan<byte>

File public metadata.

PrivateMeta

override ReadOnlySpan<byte>

File private (encrypted) metadata.

CanRead

override bool

Always false/.

CanSeek

override bool

Always false/.

CanWrite

override bool

True until file is disposed.

Length

override long

Fixed length of the file.

Position

override long

Returns current position in the file.

ManagedInboxEntryWriter

public class ManagedInboxEntryWriter : IAsyncDisposable
{
    IReadOnlyDictionary<string, InboxWriteFileStream> FileStreams {get; set;}
}

Fields

FileStreams

IReadOnlyDictionary<string, InboxWriteFileStream>

Mapping of user selected usernames to file streams.

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.