privmx-endpoint/com.simplito.kotlin.privmx_endpoint.model

Package-level declarations

Types

BIP39

data class BIP39(val mnemonic: String, val extKey: ExtKey, val entropy: ByteArray)

Class containing ECC generated key using BIP-39.

BridgeIdentity

data class BridgeIdentity(val url: String, val pubKey: String? = null, val instanceId: String? = null)

Bridge server identification details.

CollectionItemChange

class CollectionItemChange(val itemId: String, val action: String)

Contains information about the changed item in the collection.

ContainerPolicy

class ContainerPolicy(val get: String?, val update: String?, val delete: String?, val updatePolicy: String?, val updaterCanBeRemovedFromManagers: String?, val ownerCanBeRemovedFromManagers: String?, val item: ItemPolicy?) : ContainerPolicyWithoutItem

Contains container and its items policies.

ContainerPolicyWithoutItem

open class ContainerPolicyWithoutItem(val get: String?, val update: String?, val delete: String?, val updatePolicy: String?, val updaterCanBeRemovedFromManagers: String?, val ownerCanBeRemovedFromManagers: String?)

Contains container's policies.

Context

data class Context(val userId: String, val contextId: String)

Contains base Context information.

Event

class Event<T : Any>(val type: String, val channel: String, val connectionId: Long?, val subscriptions: List<String>, val timestamp: Long?, val data: T)

Represents a generic event caught by PrivMX Endpoint.

File

data class File(val info: ServerFileInfo, val publicMeta: ByteArray, val privateMeta: ByteArray, val size: Long?, val authorPubKey: String, val statusCode: Long?, val schemaVersion: Long?, var randomWrite: Boolean = false)

Holds information about the file.

FileChange

class FileChange(var pos: Long?, var length: Long?, var truncate: Boolean)

Holds information about the file change.

FilesConfig

data class FilesConfig(val minCount: Long?, val maxCount: Long?, val maxFileSize: Long?, val maxWholeUploadSize: Long?)

Holds Inbox files configuration.

Inbox

data class Inbox(val inboxId: String, val contextId: String, val createDate: Long?, val creator: String, val lastModificationDate: Long?, val lastModifier: String, val users: List<String>, val managers: List<String>, val version: Long?, val publicMeta: ByteArray, val privateMeta: ByteArray, val filesConfig: FilesConfig?, val policy: ContainerPolicyWithoutItem, val statusCode: Long?, val schemaVersion: Long?)

Holds all available information about an Inbox.

InboxEntry

data class InboxEntry(val entryId: String, val inboxId: String, val data: ByteArray, val files: List<File>, val authorPubKey: String, val createDate: Long?, val statusCode: Long?, val schemaVersion: Long?)

Holds information about Inbox entry.

InboxPublicView

data class InboxPublicView(val inboxId: String, val version: Long?, val publicMeta: ByteArray)

Holds Inbox public information.

ItemPolicy

class ItemPolicy(val get: String?, val listMy: String?, val listAll: String?, val create: String?, val update: String?, val delete: String?)

Contains container items policies.

Kvdb

data class Kvdb(val contextId: String, val kvdbId: String, val createDate: Long?, val creator: String, val lastModificationDate: Long?, val lastModifier: String, val users: List<String>, val managers: List<String>, val version: Long?, val publicMeta: ByteArray, val privateMeta: ByteArray, val entries: Long?, val lastEntryDate: Long?, val policy: ContainerPolicy?, val statusCode: Long?, val schemaVersion: Long?)

Holds all available information about a KVDB.

KvdbEntry

class KvdbEntry(val info: ServerKvdbEntryInfo, val publicMeta: ByteArray, val privateMeta: ByteArray, val data: ByteArray, val authorPubKey: String, val version: Long?, val statusCode: Long?, val schemaVersion: Long?)

Holds all available information about an Entry.

Message

data class Message(val info: ServerMessageInfo, val publicMeta: ByteArray, val privateMeta: ByteArray, val data: ByteArray, val authorPubKey: String, val statusCode: Long?, val schemaVersion: Long?)

Holds information about the Message.

PagingList

class PagingList<T>(val totalAvailable: Long?, val readItems: List<T>)

Contains results of listing methods.

PKIVerificationOptions

data class PKIVerificationOptions(val bridgePubKey: String? = null, val bridgeInstanceId: String? = null)

PrivMX Bridge server instance verification options using a PKI server.

ServerFileInfo

data class ServerFileInfo(val storeId: String, val fileId: String, val createDate: Long?, val author: String)

Holds file's information created by server.

ServerKvdbEntryInfo

class ServerKvdbEntryInfo(val kvdbId: String, val key: String, val createDate: Long?, val author: String)

Holds KVDB entry's information created by the server.

ServerMessageInfo

data class ServerMessageInfo(val threadId: String, val messageId: String, val createDate: Long?, val author: String)

Holds message's information created by server.

Store

data class Store(val storeId: String, val contextId: String, val createDate: Long?, val creator: String, val lastModificationDate: Long?, val lastFileDate: Long?, val lastModifier: String, val users: List<String>, val managers: List<String>, val version: Long?, val publicMeta: ByteArray, val privateMeta: ByteArray, val policy: ContainerPolicy, val filesCount: Long?, val statusCode: Long?, val schemaVersion: Long?)

Holds all available information about a Store.

Thread

data class Thread(val contextId: String, val threadId: String, val createDate: Long?, val creator: String, val lastModificationDate: Long?, val lastModifier: String, val users: List<String>, val managers: List<String>, val version: Long?, val lastMsgDate: Long?, val publicMeta: ByteArray, val privateMeta: ByteArray, val policy: ContainerPolicy, val messagesCount: Long?, val statusCode: Long?, val schemaVersion: Long?)

Holds all available information about a Thread.

UserInfo

data class UserInfo(val user: UserWithPubKey, val isActive: Boolean, val lastStatusChange: UserStatusChange? = null)

Contains Information about user.

UserStatusChange

class UserStatusChange(val action: String, val timestamp: Long?)

Contains information about the change of user status.

UserWithAction

class UserWithAction(val user: UserWithPubKey, val action: String)

Contains the user with their status change action.

UserWithPubKey

data class UserWithPubKey(val userId: String, val pubKey: String)

Contains ID of user and the corresponding public key.

VerificationRequest

data class VerificationRequest(val contextId: String, val senderId: String, val senderPubKey: String, val date: Long?, val bridgeIdentity: BridgeIdentity? = null)