privmx-endpoint/com.simplito.kotlin.privmx_endpoint.modules.store/StoreApi

StoreApi

expect class StoreApi(connection: Connection) : AutoCloseable

Manages PrivMX Bridge Stores and Files.

Parameters

connection

active connection to PrivMX Bridge

Throws

IllegalStateException

when given Connection is not connected

actual class StoreApi(connection: Connection) : AutoCloseable

Manages PrivMX Bridge Stores and Files.

Parameters

connection

active connection to PrivMX Bridge

Throws

IllegalStateException

when given Connection is not connected

actual class StoreApi(connection: Connection) : AutoCloseable

Manages PrivMX Bridge Stores and Files.

Parameters

connection

active connection to PrivMX Bridge

Throws

IllegalStateException

when given Connection is not connected

Constructors

StoreApi

expect constructor(connection: Connection)

actual constructor(connection: Connection)

Types

Companion

object Companion

Functions

expect open override fun close()

Frees memory.

actual open override fun close()

Frees memory.

actual open override fun close()

Frees memory.

closeFile

expect fun closeFile(fileHandle: Long): String

Closes the file handle.

actual fun closeFile(fileHandle: Long): String

Closes the file handle.

actual external fun closeFile(fileHandle: Long): String

Closes the file handle.

createFile

expect fun createFile(storeId: String, publicMeta: ByteArray, privateMeta: ByteArray, size: Long): Long?

Creates a new file in a Store.

actual fun createFile(storeId: String, publicMeta: ByteArray, privateMeta: ByteArray, size: Long): Long?

Creates a new file in a Store.

actual external fun createFile(storeId: String, publicMeta: ByteArray, privateMeta: ByteArray, size: Long): Long?

Creates a new file in a Store.

createStore

expect fun createStore(contextId: String, users: List<UserWithPubKey>, managers: List<UserWithPubKey>, publicMeta: ByteArray, privateMeta: ByteArray, policies: ContainerPolicy? = null): String

Creates a new Store in given Context.

actual fun createStore(contextId: String, users: List<UserWithPubKey>, managers: List<UserWithPubKey>, publicMeta: ByteArray, privateMeta: ByteArray, policies: ContainerPolicy?): String

Creates a new Store in given Context.

@JvmOverloads

actual external fun createStore(contextId: String, users: List<UserWithPubKey>, managers: List<UserWithPubKey>, publicMeta: ByteArray, privateMeta: ByteArray, policies: ContainerPolicy?): String

Creates a new Store in given Context.

deleteFile

expect fun deleteFile(fileId: String)

Deletes a file by given ID.

actual fun deleteFile(fileId: String)

Deletes a file by given ID.

actual external fun deleteFile(fileId: String)

Deletes a file by given ID.

deleteStore

expect fun deleteStore(storeId: String)

Deletes a Store by given Store ID.

actual fun deleteStore(storeId: String)

Deletes a Store by given Store ID.

actual external fun deleteStore(storeId: String)

Deletes a Store by given Store ID.

getFile

expect fun getFile(fileId: String): File

Gets a single file by the given file ID.

actual fun getFile(fileId: String): File

Gets a single file by the given file ID.

actual external fun getFile(fileId: String): File

Gets a single file by the given file ID.

getStore

expect fun getStore(storeId: String): Store

Gets a single Store by given Store ID.

actual fun getStore(storeId: String): Store

Gets a single Store by given Store ID.

actual external fun getStore(storeId: String): Store

Gets a single Store by given Store ID.

listFiles

expect fun listFiles(storeId: String, skip: Long, limit: Long, sortOrder: String = "desc", lastId: String? = null): PagingList<File>

Gets a list of files in given Store.

actual fun listFiles(storeId: String, skip: Long, limit: Long, sortOrder: String, lastId: String?): PagingList<File>

Gets a list of files in given Store.

@JvmOverloads

actual external fun listFiles(storeId: String, skip: Long, limit: Long, sortOrder: String, lastId: String?): PagingList<File>

Gets a list of files in given Store.

listStores

expect fun listStores(contextId: String, skip: Long, limit: Long, sortOrder: String = "desc", lastId: String? = null): PagingList<Store>

Gets a list of Stores in given Context.

actual fun listStores(contextId: String, skip: Long, limit: Long, sortOrder: String, lastId: String?): PagingList<Store>

Gets a list of Stores in given Context.

@JvmOverloads

actual external fun listStores(contextId: String, skip: Long, limit: Long, sortOrder: String, lastId: String?): PagingList<Store>

Gets a list of Stores in given Context.

openFile

expect fun openFile(fileId: String): Long?

Opens a file to read.

actual fun openFile(fileId: String): Long?

Opens a file to read.

actual external fun openFile(fileId: String): Long?

Opens a file to read.

readFromFile

expect fun readFromFile(fileHandle: Long, length: Long): ByteArray

Reads file data.

actual fun readFromFile(fileHandle: Long, length: Long): ByteArray

Reads file data.

actual external fun readFromFile(fileHandle: Long, length: Long): ByteArray

Reads file data.

seekInFile

expect fun seekInFile(fileHandle: Long, position: Long)

Moves read cursor.

actual fun seekInFile(fileHandle: Long, position: Long)

Moves read cursor.

actual external fun seekInFile(fileHandle: Long, position: Long)

Moves read cursor.

subscribeForFileEvents

expect fun subscribeForFileEvents(storeId: String)

Subscribes for events in given Store.

actual fun subscribeForFileEvents(storeId: String)

Subscribes for events in given Store.

actual external fun subscribeForFileEvents(storeId: String)

Subscribes for events in given Store.

subscribeForStoreEvents

expect fun subscribeForStoreEvents()

Subscribes for the Store module main events.

actual fun subscribeForStoreEvents()

Subscribes for the Store module main events.

actual external fun subscribeForStoreEvents()

Subscribes for the Store module main events.

unsubscribeFromFileEvents

expect fun unsubscribeFromFileEvents(storeId: String)

Unsubscribes from events in given Store.

actual fun unsubscribeFromFileEvents(storeId: String)

Unsubscribes from events in given Store.

actual external fun unsubscribeFromFileEvents(storeId: String)

Unsubscribes from events in given Store.

unsubscribeFromStoreEvents

expect fun unsubscribeFromStoreEvents()

Unsubscribes from the Store module main events.

actual fun unsubscribeFromStoreEvents()

Unsubscribes from the Store module main events.

actual external fun unsubscribeFromStoreEvents()

Unsubscribes from the Store module main events.

updateFile

expect fun updateFile(fileId: String, publicMeta: ByteArray, privateMeta: ByteArray, size: Long): Long?

Updates an existing file in a Store.

actual fun updateFile(fileId: String, publicMeta: ByteArray, privateMeta: ByteArray, size: Long): Long?

Updates an existing file in a Store.

actual external fun updateFile(fileId: String, publicMeta: ByteArray, privateMeta: ByteArray, size: Long): Long?

Updates an existing file in a Store.

updateFileMeta

expect fun updateFileMeta(fileId: String, publicMeta: ByteArray, privateMeta: ByteArray)

Updates metadata of an existing file in a Store.

actual fun updateFileMeta(fileId: String, publicMeta: ByteArray, privateMeta: ByteArray)

Updates metadata of an existing file in a Store.

actual external fun updateFileMeta(fileId: String, publicMeta: ByteArray, privateMeta: ByteArray)

Updates metadata of an existing file in a Store.

updateStore

expect fun updateStore(storeId: String, users: List<UserWithPubKey>, managers: List<UserWithPubKey>, publicMeta: ByteArray, privateMeta: ByteArray, version: Long, force: Boolean = false, forceGenerateNewKey: Boolean = false, policies: ContainerPolicy? = null)

Updates an existing Store.

actual fun updateStore(storeId: String, users: List<UserWithPubKey>, managers: List<UserWithPubKey>, publicMeta: ByteArray, privateMeta: ByteArray, version: Long, force: Boolean, forceGenerateNewKey: Boolean, policies: ContainerPolicy?)

Updates an existing Store.

@JvmOverloads

actual external fun updateStore(storeId: String, users: List<UserWithPubKey>, managers: List<UserWithPubKey>, publicMeta: ByteArray, privateMeta: ByteArray, version: Long, force: Boolean, forceGenerateNewKey: Boolean, policies: ContainerPolicy?)

Updates an existing Store.

writeToFile

expect fun writeToFile(fileHandle: Long, dataChunk: ByteArray)

Writes a file data.

actual fun writeToFile(fileHandle: Long, dataChunk: ByteArray)

Writes a file data.

actual external fun writeToFile(fileHandle: Long, dataChunk: ByteArray)

Writes a file data.