Threads | PrivMX Docs

Class representing instance of Threads API

Fields

native

ThreadApiNative

Methods

createThread

Creates a new Thread in given Context.

Params

contextId

string

ID of the Context to create the Thread in

users

UserWithPubKey[]

array of UserWithPubKey structs which indicates who will have access to the created Thread

managers

UserWithPubKey[]

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

publicMeta

Uint8Array

public (unencrypted) metadata

privateMeta

Uint8Array

private (encrypted) metadata

policies

ContainerPolicy

Thread's policies

createThread(contextId, users, managers, publicMeta, privateMeta, policies)

Returns

Promise<string> · ID of the created Thread

updateThread

Updates an existing Thread.

Params

threadId

string

ID of the Thread to update

users

UserWithPubKey[]

array of UserWithPubKey structs which indicates who will have access to the created Thread

managers

UserWithPubKey[]

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

publicMeta

Uint8Array

public (unencrypted) metadata

privateMeta

Uint8Array

private (encrypted) metadata

version

number

current version of the updated Thread

force

boolean

force update (without checking version)

forceGenerateNewKey

boolean

force to regenerate a key for the Thread

policies

ContainerPolicy

Thread's policies

updateThread(threadId, users, managers, publicMeta, privateMeta, version, force, forceGenerateNewKey, policies)

deleteThread

Deletes a Thread by given Thread ID.

Params

threadId

string

ID of the Thread to delete

deleteThread(threadId)

getThread

Gets a Thread by given Thread ID.

Params

threadId

string

ID of Thread to get

getThread(threadId)

Returns

Promise<Thread> · struct containing info about the Thread

listThreads

Gets a list of Threads in given Context.

Params

contextId

string

ID of the Context to get the Threads from

pagingQuery

PagingQuery

struct with list query parameters

listThreads(contextId, pagingQuery)

Returns

Promise<PagingList<Thread>> · struct containing a list of Threads

getMessage

Gets a message by given message ID.

Params

messageId

string

ID of the message to get

getMessage(messageId)

Returns

Promise<Message> · struct containing the message

listMessages

Gets a list of messages from a Thread.

Params

threadId

string

ID of the Thread to list messages from

pagingQuery

PagingQuery

struct with list query parameters

listMessages(threadId, pagingQuery)

Returns

Promise<PagingList<Message>> · struct containing a list of messages

sendMessage

Sends a message in a Thread.

Params

threadId

string

ID of the Thread to send message to

publicMeta

Uint8Array

public message metadata

privateMeta

Uint8Array

private message metadata

data

Uint8Array

content of the message

sendMessage(threadId, publicMeta, privateMeta, data)

Returns

Promise<string> · ID of the new message

deleteMessage

Deletes a message by given message ID.

Params

messageId

string

ID of the message to delete

deleteMessage(messageId)

updateMessage

Update message in a Thread.

Params

messageId

string

ID of the message to update

publicMeta

Uint8Array

public message metadata

privateMeta

Uint8Array

private message metadata

data

Uint8Array

content of the message

updateMessage(messageId, publicMeta, privateMeta, data)

subscribeForThreadEvents

Subscribes for the Thread module main events.

subscribeForThreadEvents()

unsubscribeFromThreadEvents

Unsubscribes from the Thread module main events.

unsubscribeFromThreadEvents()

subscribeForMessageEvents

Subscribes for events in given Thread.

Params

threadId

string

ID of the Thread to subscribe

subscribeForMessageEvents(threadId)

unsubscribeFromMessageEvents

Unsubscribes from events in given Thread.

Params

threadId

string

ID of the Thread to unsubscribe

unsubscribeFromMessageEvents(threadId)