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

updateInbox

expect fun updateInbox(inboxId: String, users: List<UserWithPubKey>, managers: List<UserWithPubKey>, publicMeta: ByteArray, privateMeta: ByteArray, filesConfig: FilesConfig? = null, version: Long, force: Boolean = false, forceGenerateNewKey: Boolean = false, policies: ContainerPolicyWithoutItem? = null)

Updates an existing Inbox.

Parameters

inboxId

ID of the Inbox to update

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

version

current version of the updated Inbox

force

force update (without checking version)

forceGenerateNewKey

force to regenerate a key for the Inbox

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 updateInbox(inboxId: String, users: List<UserWithPubKey>, managers: List<UserWithPubKey>, publicMeta: ByteArray, privateMeta: ByteArray, filesConfig: FilesConfig?, version: Long, force: Boolean, forceGenerateNewKey: Boolean, policies: ContainerPolicyWithoutItem?)

Updates an existing Inbox.

Parameters

inboxId

ID of the Inbox to update

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

version

current version of the updated Inbox

force

force update (without checking version)

forceGenerateNewKey

force to regenerate a key for the Inbox

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 updateInbox(inboxId: String, users: List<UserWithPubKey>, managers: List<UserWithPubKey>, publicMeta: ByteArray, privateMeta: ByteArray, filesConfig: FilesConfig?, version: Long, force: Boolean, forceGenerateNewKey: Boolean, policies: ContainerPolicyWithoutItem?)

Updates an existing Inbox.

Parameters

inboxId

ID of the Inbox to update

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

version

current version of the updated Inbox

force

force update (without checking version)

forceGenerateNewKey

force to regenerate a key for the Inbox

policies

additional container access policies

Throws

thrown when method encounters an exception

thrown when method encounters an unknown exception

thrown when instance is closed