Models | PrivMX Docs

Message

public class Message
{
    ServerMessageInfo Info {get; set;}
    byte[] PublicMeta {get; set;}
    byte[] PrivateMeta {get; set;}
    byte[] Data {get; set;}
    string AuthorPubKey {get; set;}
    long StatusCode {get; set;}
}

Fields

Info

ServerMessageInfo

Server metadata.

PublicMeta

byte[]

Public metadata.

PrivateMeta

byte[]

Private metadata.

Data

byte[]

Payload of the message.

AuthorPubKey

string

Verified public key of the PublicMeta, PrivateMeta and Data author.

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.

ServerMessageInfo

public class ServerMessageInfo
{
    string ThreadId {get; set;}
    string MessageId {get; set;}
    long CreateDate {get; set;}
    string Author {get; set;}
}

Fields

ThreadId

string

ID of the Thread.

MessageId

string

ID of the message.

CreateDate

long

Server creation timestamp.

Author

string

ID of the creator user.

Thread

public class Thread
{
    string ContextId {get; set;}
    string ThreadId {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;}
    long LastMsgDate {get; set;}
    byte[] PublicMeta {get; set;}
    byte[] PrivateMeta {get; set;}
    ContainerPolicy Policy {get; set;}
    long MessagesCount {get; set;}
    long StatusCode {get; set;}
}

Fields

ContextId

string

ID of the Context.

ThreadId

string

ID of the Thread.

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 Thread.

Managers

List<string>

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

Version

long

Number of the Thread updates.

LastMsgDate

long

Timestamp of the last message in the Thread, or the Thread creation timestamp if no messages in.

PublicMeta

byte[]

Public metadata.

PrivateMeta

byte[]

Private metadata.

Policy

ContainerPolicy

Thread's policy.

MessagesCount

long

Total number of messages in the Thread.

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.

ThreadCreatedEvent

public class ThreadCreatedEvent : PrivMX.Endpoint.Core.Models.Event
{
    Thread Data {get; set;}
}

Fields

Data

Thread

Created Thread.

ThreadDeletedEvent

public class ThreadDeletedEvent : PrivMX.Endpoint.Core.Models.Event
{
    ThreadDeletedEventData Data {get; set;}
}

Fields

Data

ThreadDeletedEventData

Deleted Thread metadata.

ThreadDeletedEventData

public class ThreadDeletedEventData
{
    string ThreadId {get; set;}
}

Fields

ThreadId

string

ID of the deleted Thread.

ThreadDeletedMessageEventData

public class ThreadDeletedMessageEventData
{
    string ThreadId {get; set;}
    string MessageId {get; set;}
}

Fields

ThreadId

string

ID of the Thread that the message is deleted from.

MessageId

string

ID of the deleted message.

ThreadMessageDeletedEvent

public class ThreadMessageDeletedEvent : PrivMX.Endpoint.Core.Models.Event
{
    ThreadDeletedMessageEventData Data {get; set;}
}

Fields

Data

ThreadDeletedMessageEventData

Deleted message metadata.

ThreadMessageUpdatedEvent

public class ThreadMessageUpdatedEvent : PrivMX.Endpoint.Core.Models.Event
{
    Message Data {get; set;}
}

Fields

Data

Message

Updated message.

ThreadNewMessageEvent

public class ThreadNewMessageEvent : PrivMX.Endpoint.Core.Models.Event
{
    Message Data {get; set;}
}

Fields

Data

Message

Created message.

ThreadStatsChangedEvent

public class ThreadStatsChangedEvent : PrivMX.Endpoint.Core.Models.Event
{
    ThreadStatsEventData Data {get; set;}
}

Fields

Data

ThreadStatsEventData

Thread statistics.

ThreadStatsEventData

public class ThreadStatsEventData
{
    string ThreadId {get; set;}
    long LastMsgDate {get; set;}
    long MessagesCount {get; set;}
}

Fields

ThreadId

string

ID of the Thread.

LastMsgDate

long

Last message timestamp.

MessagesCount

long

Total number of messages in the Thread.

ThreadUpdatedEvent

public class ThreadUpdatedEvent : PrivMX.Endpoint.Core.Models.Event
{
    Thread Data {get; set;}
}

Fields

Data

Thread

Updated Thread.