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

when given Connection is not connected

actual class ThreadApi(connection: Connection) : AutoCloseable

Manages Threads and messages.

Parameters

connection

active connection to PrivMX Bridge

Throws

when given Connection is not connected

actual class ThreadApi(connection: Connection) : AutoCloseable

Manages Threads and messages.

Parameters

connection

active connection to PrivMX Bridge

Throws

when given Connection is not connected

Constructors

Link copied to clipboard
expect constructor(connection: Connection)
actual constructor(connection: Connection)
actual constructor(connection: Connection)

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
expect fun buildSubscriptionQuery(eventType: ThreadEventType, selectorType: ThreadEventSelectorType, selectorId: String): String

Generate subscription Query for the Thread events.

actual fun buildSubscriptionQuery(eventType: ThreadEventType, selectorType: ThreadEventSelectorType, selectorId: String): String

Generate subscription Query for the Thread events.

actual fun buildSubscriptionQuery(eventType: ThreadEventType, selectorType: ThreadEventSelectorType, selectorId: String): String

Generate subscription Query for the Thread events.

Link copied to clipboard
expect open override fun close()

Frees memory.

actual open override fun close()

Frees memory.

actual open override fun close()

Frees memory.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
expect fun listMessages(threadId: String, skip: Long, limit: Long, sortOrder: String = "desc", lastId: String? = null, queryAsJson: String? = null, sortBy: 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?, queryAsJson: String?, sortBy: 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?, queryAsJson: String?, sortBy: String?): PagingList<Message>

Gets a list of messages from a Thread.

Link copied to clipboard
expect fun listThreads(contextId: String, skip: Long, limit: Long, sortOrder: String = "desc", lastId: String? = null, queryAsJson: String? = null, sortBy: 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?, queryAsJson: String?, sortBy: 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?, queryAsJson: String?, sortBy: String?): PagingList<Thread>

Gets a list of Threads in given Context.

Link copied to clipboard
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.

Link copied to clipboard
expect fun subscribeFor(subscriptionQueries: List<String>): List<String>

Subscribe for the Thread events on the given subscription query.

actual fun subscribeFor(subscriptionQueries: List<String>): List<String>

Subscribe for the Thread events on the given subscription query.

actual external fun subscribeFor(subscriptionQueries: List<String>): List<String>

Subscribe for the Thread events on the given subscription query.

Link copied to clipboard
expect fun unsubscribeFrom(subscriptionIds: List<String>)

Unsubscribe from events with the given subscriptionId.

actual fun unsubscribeFrom(subscriptionIds: List<String>)

Unsubscribe from events with the given subscriptionId.

actual external fun unsubscribeFrom(subscriptionIds: List<String>)

Unsubscribe from events with the given subscriptionId.

Link copied to clipboard
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.

Link copied to clipboard
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.