privmx-endpoint/com.simplito.kotlin.privmx_endpoint.modules.inbox/InboxApi/createInbox

createInbox

expect fun createInbox(contextId: String, users: List<UserWithPubKey>, managers: List<UserWithPubKey>, publicMeta: ByteArray, privateMeta: ByteArray, filesConfig: FilesConfig? = null, policies: ContainerPolicyWithoutItem? = null): String

Creates a new Inbox.

Return

ID of the created Inbox

Parameters

contextId

ID of the Context of the new Inbox

users

list of UserWithPubKey structs which indicates who will have access to the created Inbox

managers

list of UserWithPubKey structs which indicates who will have access (and management rights) to the created Inbox

publicMeta

public (unencrypted) metadata

privateMeta

private (encrypted) metadata

filesConfig

overrides default file configuration

policies

additional container access policies

Throws

thrown when method encounters an exception

thrown when method encounters an unknown exception

thrown when instance is closed

actual fun createInbox(contextId: String, users: List<UserWithPubKey>, managers: List<UserWithPubKey>, publicMeta: ByteArray, privateMeta: ByteArray, filesConfig: FilesConfig?, policies: ContainerPolicyWithoutItem?): String

Creates a new Inbox.

Return

ID of the created Inbox

Parameters

contextId

ID of the Context of the new Inbox

users

list of UserWithPubKey structs which indicates who will have access to the created Inbox

managers

list of UserWithPubKey structs which indicates who will have access (and management rights) to the created Inbox

publicMeta

public (unencrypted) metadata

privateMeta

private (encrypted) metadata

filesConfig

overrides default file configuration

policies

additional container access policies

Throws

thrown when method encounters an exception

thrown when method encounters an unknown exception

thrown when instance is closed

@JvmOverloads
actual external fun createInbox(contextId: String, users: List<UserWithPubKey>, managers: List<UserWithPubKey>, publicMeta: ByteArray, privateMeta: ByteArray, filesConfig: FilesConfig?, policies: ContainerPolicyWithoutItem?): String

Creates a new Inbox.

Return

ID of the created Inbox

Parameters

contextId

ID of the Context of the new Inbox

users

list of UserWithPubKey structs which indicates who will have access to the created Inbox

managers

list of UserWithPubKey structs which indicates who will have access (and management rights) to the created Inbox

publicMeta

public (unencrypted) metadata

privateMeta

private (encrypted) metadata

filesConfig

overrides default file configuration

policies

additional container access policies

Throws

thrown when method encounters an exception

thrown when method encounters an unknown exception

thrown when instance is closed