privmx-endpoint/com.simplito.kotlin.privmx_endpoint.modules.thread/ThreadApi

ThreadApi

expect class ThreadApi(connection: Connection) : AutoCloseable

Manages Threads and messages.

Parameters

connection

active connection to PrivMX Bridge

Throws

IllegalStateException

when given Connection is not connected

actual class ThreadApi(connection: Connection) : AutoCloseable

Manages Threads and messages.

Parameters

connection

active connection to PrivMX Bridge

Throws

IllegalStateException

when given Connection is not connected

actual class ThreadApi(connection: Connection) : AutoCloseable

Manages Threads and messages.

Parameters

connection

active connection to PrivMX Bridge

Throws

IllegalStateException

when given Connection is not connected

Constructors

ThreadApi

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.

createThread

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

Creates a new Thread in given Context.

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

Creates a new Thread in given Context.

@JvmOverloads

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

Creates a new Thread in given Context.

deleteMessage

expect fun deleteMessage(messageId: String)

Deletes a message by given message ID.

actual fun deleteMessage(messageId: String)

Deletes a message by given message ID.

actual external fun deleteMessage(messageId: String)

Deletes a message by given message ID.

deleteThread

expect fun deleteThread(threadId: String)

Deletes a Thread by given Thread ID.

actual fun deleteThread(threadId: String)

Deletes a Thread by given Thread ID.

actual external fun deleteThread(threadId: String)

Deletes a Thread by given Thread ID.

getMessage

expect fun getMessage(messageId: String): Message

Gets a message by given message ID.

actual fun getMessage(messageId: String): Message

Gets a message by given message ID.

actual external fun getMessage(messageId: String): Message

Gets a message by given message ID.

getThread

expect fun getThread(threadId: String): Thread

Gets a Thread by given Thread ID.

actual fun getThread(threadId: String): Thread

Gets a Thread by given Thread ID.

actual external fun getThread(threadId: String): Thread

Gets a Thread by given Thread ID.

listMessages

expect fun listMessages(threadId: String, skip: Long, limit: Long, sortOrder: String = "desc", lastId: String? = null): PagingList<Message>

Gets a list of messages from a Thread.

actual fun listMessages(threadId: String, skip: Long, limit: Long, sortOrder: String, lastId: String?): PagingList<Message>

Gets a list of messages from a Thread.

@JvmOverloads

actual external fun listMessages(threadId: String, skip: Long, limit: Long, sortOrder: String, lastId: String?): PagingList<Message>

Gets a list of messages from a Thread.

listThreads

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

Gets a list of Threads in given Context.

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

Gets a list of Threads in given Context.

@JvmOverloads

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

Gets a list of Threads in given Context.

sendMessage

expect fun sendMessage(threadId: String, publicMeta: ByteArray, privateMeta: ByteArray, data: ByteArray): String

Sends a message in a Thread.

actual fun sendMessage(threadId: String, publicMeta: ByteArray, privateMeta: ByteArray, data: ByteArray): String

Sends a message in a Thread.

actual external fun sendMessage(threadId: String, publicMeta: ByteArray, privateMeta: ByteArray, data: ByteArray): String

Sends a message in a Thread.

subscribeForMessageEvents

expect fun subscribeForMessageEvents(threadId: String)

Subscribes for events in given Thread.

actual fun subscribeForMessageEvents(threadId: String)

Subscribes for events in given Thread.

actual external fun subscribeForMessageEvents(threadId: String)

Subscribes for events in given Thread.

subscribeForThreadEvents

expect fun subscribeForThreadEvents()

Subscribes for the Thread module main events.

actual fun subscribeForThreadEvents()

Subscribes for the Thread module main events.

actual external fun subscribeForThreadEvents()

Subscribes for the Thread module main events.

unsubscribeFromMessageEvents

expect fun unsubscribeFromMessageEvents(threadId: String)

Unsubscribes from events in given Thread.

actual fun unsubscribeFromMessageEvents(threadId: String)

Unsubscribes from events in given Thread.

actual external fun unsubscribeFromMessageEvents(threadId: String)

Unsubscribes from events in given Thread.

unsubscribeFromThreadEvents

expect fun unsubscribeFromThreadEvents()

Unsubscribes from the Thread module main events.

actual fun unsubscribeFromThreadEvents()

Unsubscribes from the Thread module main events.

actual external fun unsubscribeFromThreadEvents()

Unsubscribes from the Thread module main events.

updateMessage

expect fun updateMessage(messageId: String, publicMeta: ByteArray, privateMeta: ByteArray, data: ByteArray)

Updates message in a Thread.

actual fun updateMessage(messageId: String, publicMeta: ByteArray, privateMeta: ByteArray, data: ByteArray)

Updates message in a Thread.

actual external fun updateMessage(messageId: String, publicMeta: ByteArray, privateMeta: ByteArray, data: ByteArray)

Updates message in a Thread.

updateThread

expect fun updateThread(threadId: 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 Thread.

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

Updates an existing Thread.

@JvmOverloads

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

Updates an existing Thread.