Models | PrivMX Docs

FilesConfig

public class FilesConfig
{
    long MinCount {get; set;}
    long MaxCount {get; set;}
    long MaxFileSize {get; set;}
    long MaxWholeUploadSize {get; set;}
}

Fields

MinCount

long

Minimal number of files to create a new entry.

MaxCount

long

Maximum number of files to create a new entry.

MaxFileSize

long

Maximum file size to create file in a new entry.

MaxWholeUploadSize

long

Maximum total size of files to create a new entry.

Inbox

public class Inbox
{
    string InboxId {get; set;}
    string ContextId {get; set;}
    long CreateDate {get; set;}
    string Creator {get; set;}
    long LastModificationDate {get; set;}
    string LastModifier {get; set;}
    List<string> Users {get; set;}
    List<string> Managers {get; set;}
    long Version {get; set;}
    byte[] PublicMeta {get; set;}
    byte[] PrivateMeta {get; set;}
    FilesConfig? FilesConfig {get; set;}
    ContainerPolicyWithoutItem Policy {get; set;}
    long StatusCode {get; set;}
}

Fields

InboxId

string

ID of the Inbox.

ContextId

string

ID og the Context.

CreateDate

long

Server creation timestamp.

Creator

string

ID of the creator user.

LastModificationDate

long

Last modification timestamp.

LastModifier

string

ID of the user who was last a modifier.

Users

List<string>

List of user IDs that have access to the Inbox.

Managers

List<string>

List of user IDs that have management rights to the Inbox.

Version

long

Number of the Inbox updates.

PublicMeta

byte[]

Public metadata.

PrivateMeta

byte[]

Private metadata.

FilesConfig

FilesConfig?

(optional) Files configuration for the Inbox.

Policy

ContainerPolicyWithoutItem

Inbox policy.

StatusCode

long

Status code of decryption and verification of the Thread.

If value is equal 0, then the Thread is successfully decrypted and verified. Otherwise, status code is compatible with codes of exceptions.

InboxCreatedEvent

public class InboxCreatedEvent : PrivMX.Endpoint.Core.Models.Event
{
    Inbox Data {get; set;}
}

Fields

Data

Inbox

Created Inbox.

InboxDeletedEvent

public class InboxDeletedEvent : PrivMX.Endpoint.Core.Models.Event
{
    InboxDeletedEventData Data {get; set;}
}

Fields

Data

InboxDeletedEventData

Metadata of the deleted Inbox.

InboxDeletedEventData

public class InboxDeletedEventData
{
    string InboxId {get; set;}
}

Fields

InboxId

string

ID of the deleted Inbox.

InboxEntry

public class InboxEntry
{
    string EntryId {get; set;}
    string InboxId {get; set;}
    byte[] Data {get; set;}
    List<File> Files {get; set;}
    string AuthorPubKey {get; set;}
    long CreateDate {get; set;}
    long StatusCode {get; set;}
}

Fields

EntryId

string

ID of the entry in the Inbox.

InboxId

string

ID of the Inbox.

Data

byte[]

Payload of the entry.

Files

List<File>

List of files in the entry.

AuthorPubKey

string

Verified public key of the Data author.

CreateDate

long

Server creation timestamp.

StatusCode

long

Status code of decryption and verification of the message.

If value is equal 0, then the message is successfully decrypted and verified. Otherwise, status code is compatible with codes of exceptions.

InboxEntryCreatedEvent

public class InboxEntryCreatedEvent : PrivMX.Endpoint.Core.Models.Event
{
    InboxEntry Data {get; set;}
}

Fields

Data

InboxEntry

Created Inbox entry.

InboxEntryDeletedEvent

public class InboxEntryDeletedEvent : PrivMX.Endpoint.Core.Models.Event
{
    InboxEntryDeletedEventData Data {get; set;}
}

Fields

Data

InboxEntryDeletedEventData

Metadata of the deleted entry.

InboxEntryDeletedEventData

public class InboxEntryDeletedEventData
{
    string InboxId {get; set;}
    string EntryId {get; set;}
}

Fields

InboxId

string

ID of the Inbox that the entry is deleted from.

EntryId

string

ID of the deleted Inbox entry.

InboxPublicView

public class InboxPublicView
{
    string InboxId {get; set;}
    long Version {get; set;}
    byte[] PublicMeta {get; set;}
}

Fields

InboxId

string

ID of the Inbox.

Version

long

Number of the Inbox updates.

PublicMeta

byte[]

Public metadata.

InboxUpdatedEvent

public class InboxUpdatedEvent : PrivMX.Endpoint.Core.Models.Event
{
    Inbox Data {get; set;}
}

Fields

Data

Inbox

Updated Inbox.