Models | PrivMX Docs

ContainerPolicy

public class ContainerPolicy : ContainerPolicyWithoutItem
{
    ItemPolicy? Item {get; set;}
}

Fields

Item

ItemPolicy?

(optional) Item policy.

ContainerPolicyWithoutItem

public class ContainerPolicyWithoutItem
{
    string? Get {get; set;}
    string? Update {get; set;}
    string? Delete_ {get; set;}
    string? UpdatePolicy {get; set;}
    string? UpdaterCanBeRemovedFromManagers {get; set;}
    string? OwnerCanBeRemovedFromManagers {get; set;}
}

Fields

Get

string?

(optional) Determines who can get the container.

Update

string?

(optional) Determines who can update the container.

Delete_

string?

(optional) Determines who can delete the container.

UpdatePolicy

string?

(optional) Determines who can update this policy.

UpdaterCanBeRemovedFromManagers

string?

(optional) Determines whether the updater can be removed from the list of managers.

OwnerCanBeRemovedFromManagers

string?

(optional) Determines whether the owner can be removed from the list of managers.

Context

public class Context
{
    string UserId {get; set;}
    string ContextId {get; set;}
}

Fields

UserId

string

ID of the current user in the Context.

ContextId

string

ID of the Context.

Error

public class Error
{
    long Code {get; set;}
    string? Message {get; set;}
    string? Name {get; set;}
    string? Scope {get; set;}
    string? Description {get; set;}
    string? Full {get; set;}
}

Fields

Code

long

ID of the native exception.

Message

string?

Readable error message.

Name

string?

Name of the native exception.

Scope

string?

Source module.

Description

string?

Addtional detailed description.

Full

string?

Serialized exception data.

Event

public class Event
{
    string Type {get; set;}
    string Channel {get; set;}
    long ConnectionId {get; set;}
}

Fields

Type

string

Type of event.

Channel

string

Additional identifier of the subscribed source module and resource.

ConnectionId

long

ID of the connection emitting the event.

ItemPolicy

public class ItemPolicy
{
    string? Get {get; set;}
    string? ListMy {get; set;}
    string? ListAll {get; set;}
    string? Create {get; set;}
    string? Update {get; set;}
    string? Delete_ {get; set;}
}

Fields

Get

string?

(optional) Determines who can get an item.

ListMy

string?

(optional) Determines who can list items created by me.

ListAll

string?

(optional) Determines who can list all items.

Create

string?

(optional) Determines who can create an item.

Update

string?

(optional) Determines who can update an item.

Delete_

string?

(optional) Determines who can delete an item.

LibBreakEvent

public class LibBreakEvent : Event
{
}

Fields

LibConnectedEvent

public class LibConnectedEvent : Event
{
}

Fields

LibDisconnectedEvent

public class LibDisconnectedEvent : Event
{
}

Fields

LibPlatformDisconnectedEvent

public class LibPlatformDisconnectedEvent : Event
{
}

Fields

PagingList

public class PagingList<T>
{
    long TotalAvailable {get; set;}
    List<T> ReadItems {get; set;}
}

Fields

TotalAvailable

long

Total number of all items available to list.

ReadItems

List<T>

Resulting items listed according to the paging parameters passed to a method.

PagingQuery

public class PagingQuery
{
    long Skip {get; set;}
    long Limit {get; set;}
    string SortOrder {get; set;}
    string? LastId {get; set;}
}

Fields

Skip

long

Number of items to skip when listing.

Limit

long

Number of items to list.

SortOrder

string

Sort order of items.

Allowed values: "asc" - ascending sort order, "desc" - descending sort order. Currently, results list items are sorted by creation date.

LastId

string?

(optional) ID of the item from which to list subsequent items.

If this parameter is passed, the Skip parameter is not used and can be any number.

UserWithPubKey

public class UserWithPubKey
{
    string UserId {get; set;}
    string PubKey {get; set;}
}

Fields

UserId

string

ID of the user in the Context.

PubKey

string

Public key associated with the user.