Skip to main content
reference

Inbox

FilesConfig

Holds Inbox files configuration.

public class FilesConfig{
Long maxCount,
Long maxFileSize,
Long maxWholeUploadSize,
Long minCount
}

Fields

NameTypeDescription
maxCountLongMaximum number of files allowed when sending Inbox entry.
maxFileSizeLongMaximum file size allowed when sending Inbox entry.
maxWholeUploadSizeLongMaximum size of all files in total allowed when sending Inbox entry.
minCountLongMinimum number of files required when sending Inbox entry.

Inbox

Holds all available information about an Inbox.

public class Inbox{
String contextId,
Long createDate,
String creator,
FilesConfig filesConfig,
String inboxId,
Long lastModificationDate,
String lastModifier,
List<String> managers,
byte[] privateMeta,
byte[] publicMeta,
Long statusCode,
List<String> users,
Long version
}

Fields

NameTypeDescription
contextIdStringID of the Context.
createDateLongInbox creation timestamp.
creatorStringID of the user who created the Inbox.
filesConfigFilesConfigInbox files configuration.
inboxIdStringID of the Inbox.
lastModificationDateLongInbox last modification timestamp.
lastModifierStringID of the user who last modified the Inbox.
managersList<String>List of users (their IDs) with management rights.
privateMetabyte[]Inbox private metadata.
publicMetabyte[]Inbox public metadata.
statusCodeLongStatus code of retrieval and decryption of the `Inbox`.
usersList<String>List of users (their IDs) with access to the Inbox.
versionLongVersion number (changes on updates).

InboxEntry

Holds information about Inbox entry.

public class InboxEntry{
String authorPubKey,
Long createDate,
byte[] data,
String entryId,
List<File> files,
String inboxId,
Long statusCode
}

Fields

NameTypeDescription
authorPubKeyStringPublic key of the author of an entry.
createDateLongInbox entry creation timestamp.
databyte[]Entry data.
entryIdStringID of the entry.
filesList<File>List of files attached to the entry.
inboxIdStringID of the Inbox.
statusCodeLongStatus code of retrieval and decryption of the `Inbox` entry.

InboxPublicView

Holds Inbox public information.

public class InboxPublicView{
String inboxId,
byte[] publicMeta,
Long version
}

Fields

NameTypeDescription
inboxIdStringID of the Inbox.
publicMetabyte[]Inbox public metadata.
versionLongVersion of the Inbox.