Skip to main content
reference

Types

Event

Object Event{...}

Fields

NameTypeDescription
typestringevent type
channelstringchannel
connectionIdnumberid of source connection

PagingQuery

Object PagingQuery{...}

Fields

NameTypeDescription
skipnumbernumber of elements to skip from result
limitnumberlimit of elements to return for query
sortOrderSortOrderOrder of elements in result. Use "asc" for ascending, "desc" for descening.
lastIdstringid of the element from which query results should start

PagingList

Object PagingList{...}

Fields

NameTypeDescription
totalAvailablenumbertotal items available to get
readItemsT[]list of items read during single method call

Context

Object Context{...}

Fields

NameTypeDescription
userIdstringID of user requesting information
contextIdstringID of context

UserWithPubKey

Object UserWithPubKey{...}

Fields

NameTypeDescription
userIdstringID of the user
pubKeystringuser's public key

Thread

Object Thread{...}

Fields

NameTypeDescription
contextIdstringID of the Context
threadIdstringID ot the Thread
createDatenumberThread creation timestamp
creatorstring
lastModificationDatenumberThread last modification timestamp
lastModifierstringID of the user who last modified the Thread
usersstring[]list of users (their IDs) with access to the Thread
managersstring[]list of users (their IDs) with management rights
versionnumberversion number (changes on updates)
lastMsgDatenumbertimestamp of last posted message
publicMetaUint8ArrayThread's public meta data
privateMetaUint8ArrayThread's private mata data
messagesCountnumbertotal number of messages in the Thread
statusCodenumberstatus code of retrival and decryption of the Thread

Message

Object Message{...}

Fields

NameTypeDescription
infoServerMessageInfomessage's information created by server
publicMetaUint8Arraymessage's public meta data
privateMetaUint8Arraymessage's private mata data
dataUint8Arraymessage's data
authorPubKeystringpublic key of an author of the message
statusCodenumberstatus code of retrival and decryption of the message

ServerMessageInfo

Object ServerMessageInfo{...}

Fields

NameTypeDescription
threadIdstringID of the Thread
messageIdstringID of the message
createDatenumbermessage's creation timestamp
authorstringID of the user who created the message

Store

Object Store{...}

Fields

NameTypeDescription
storeIdstringID ot the Store
contextIdstringID of the Context
createDatenumberStore creation timestamp
creatorstringID of user who created the Store
lastModificationDatenumberThread last modification timestamp
lastFileDatenumbertimestamp of last created file
lastModifierstringID of the user who last modified the Store
usersstring[]list of users (their IDs) with access to the Store
managersstring[]list of users (their IDs) with management rights
versionnumberversion number (changes on updates)
publicMetaUint8ArrayStore's public meta data
privateMetaUint8ArrayStore's private mata data
filesCountnumbertotal number of files in the Store
statusCodenumberstatus code of retrival and decryption of the Store

File

Object File{...}

Fields

NameTypeDescription
infoServerFileInfofile's information created by server
publicMetaUint8Arrayfile's public meta data
privateMetaUint8Arrayfile's private mata data
sizenumberfile's size
authorPubKeystringpublic key of an author of the file
statusCodenumber

ServerFileInfo

Object ServerFileInfo{...}

Fields

NameTypeDescription
storeIdstringID of the Store
fileIdstringID of the file
createDatenumberfile's creation timestamp
authorstringID of the user who created the file

Inbox

Object Inbox{...}

Fields

NameTypeDescription
inboxIdstringID ot the Inbox
contextIdstringID of the Context
createDatenumberInbox creation timestamp
creatorstringID of user who created the Inbox
lastModificationDatenumberInbox last modification timestamp
lastModifierstringID of the user who last modified the Inbox
usersstring[]list of users (their IDs) with access to the Inbox
managersstring[]list of users (their IDs) with management rights
versionnumberversion number (changes on updates)
publicMetaUint8ArrayInbox' public meta data
privateMetaUint8ArrayInbox' private mata data
filesConfigFilesConfigInbox' files configuration
statusCodenumberstatus code of retrival and decryption of the Inbox

InboxPublicView

Object InboxPublicView{...}

Fields

NameTypeDescription
inboxIdstringID of the Inbox
versionnumberversion of the Inbox
publicMetaUint8ArrayInbox' public meta data

InboxEntry

Object InboxEntry{...}

Fields

NameTypeDescription
entryIdstringID of the entry
inboxIdstringID of the Inbox
dataUint8Arrayentry data
filesFile[]list of files attached to the entry
authorPubKeystringpublic key of the author of an entry
createDatenumberInbox entry creation timestamp
statusCodenumberstatus code of retrival and decryption of the Inbox entry

FilesConfig

Object FilesConfig{...}

Fields

NameTypeDescription
minCountnumberminimum numer of files required when sending inbox entry
maxCountnumbermaximum numer of files allowed when sending inbox entry
maxFileSizenumbermaximum file size allowed when sending inbox entry
maxWholeUploadSizenumbermaximum size of all files in total allowed when sending inbox entry

Error

Object Error{...}

Fields

NameTypeDescription
codenumbererror code
namestringerror name
scopestringerror scope
descriptionstringerror description
fullstringall available data about the error