ThreadApi

Manages Threads and messages.

Constructors

Initialize Thread module on given active connection.

Params

connection

Connection

active connection to PrivMX Bridge

public void ThreadApi(
Connection connection
)

Methods

close

Frees memory.

public void close()

createThread

Creates a new Thread in given Context.

Params

contextId

String

ID of the Context to create the Thread in

users

List<UserWithPubKey>

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

managers

List<UserWithPubKey>

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

publicMeta

byte[]

public (unencrypted) metadata

privateMeta

byte[]

private (encrypted) metadata

public String createThread(
String contextId,
List<UserWithPubKey> users,
List<UserWithPubKey> managers,
byte[] publicMeta,
byte[] privateMeta
)

Returns

String · ID of the created Thread

createThread

Creates a new Thread in given Context.

Params

contextId

String

ID of the Context to create the Thread in

users

List<UserWithPubKey>

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

managers

List<UserWithPubKey>

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

publicMeta

byte[]

public (unencrypted) metadata

privateMeta

byte[]

private (encrypted) metadata

policies

ContainerPolicy

additional container access policies

public String createThread(
String contextId,
List<UserWithPubKey> users,
List<UserWithPubKey> managers,
byte[] publicMeta,
byte[] privateMeta,
ContainerPolicy policies
)

Returns

String · ID of the created Thread

deleteMessage

Deletes a message by given message ID.

Params

messageId

String

ID of the message to delete

public void deleteMessage(
String messageId
)

deleteThread

Deletes a Thread by given Thread ID.

Params

threadId

String

ID of the Thread to delete

public void deleteThread(
String threadId
)

getMessage

Gets a message by given message ID.

Params

messageId

String

ID of the message to get

public Message getMessage(
String messageId
)

Returns

Message · Message with matching id

getThread

Gets a Thread by given Thread ID.

Params

threadId

String

ID of Thread to get

public Thread getThread(
String threadId
)

Returns

Thread · Information about the Thread

listMessages

Gets a list of messages from a Thread.

Params

threadId

String

ID of the Thread to list messages from

skip

long

skip number of elements to skip from result

limit

long

limit of elements to return for query

sortOrder

String

order of elements in result ("asc" for ascending, "desc" for descending)

public PagingList<Message> listMessages(
String threadId,
long skip,
long limit,
String sortOrder
)

Returns

PagingList<Message> · list of messages

listMessages

Gets a list of messages from a Thread.

Params

threadId

String

ID of the Thread to list messages from

skip

long

skip number of elements to skip from result

limit

long

limit of elements to return for query

sortOrder

String

order of elements in result ("asc" for ascending, "desc" for descending)

lastId

String

ID of the element from which query results should start

public PagingList<Message> listMessages(
String threadId,
long skip,
long limit,
String sortOrder,
String lastId
)

Returns

PagingList<Message> · list of messages

listThreads

Gets a list of Threads in given Context.

Params

contextId

String

ID of the Context to get the Threads from

skip

long

skip number of elements to skip from result

limit

long

limit of elements to return for query

sortOrder

String

order of elements in result ("asc" for ascending, "desc" for descending)

public PagingList<Thread> listThreads(
String contextId,
long skip,
long limit,
String sortOrder
)

Returns

PagingList<Thread> · list of Threads

listThreads

Gets a list of Threads in given Context.

Params

contextId

String

ID of the Context to get the Threads from

skip

long

skip number of elements to skip from result

limit

long

limit of elements to return for query

sortOrder

String

order of elements in result ("asc" for ascending, "desc" for descending)

lastId

String

ID of the element from which query results should start

public PagingList<Thread> listThreads(
String contextId,
long skip,
long limit,
String sortOrder,
String lastId
)

Returns

PagingList<Thread> · list of Threads

sendMessage

Sends a message in a Thread.

Params

threadId

String

ID of the Thread to send message to

publicMeta

byte[]

public message metadata

privateMeta

byte[]

private message metadata

data

byte[]

content of the message

public String sendMessage(
String threadId,
byte[] publicMeta,
byte[] privateMeta,
byte[] data
)

Returns

String · ID of the new message

subscribeForMessageEvents

Subscribes for events in given Thread.

Params

threadId

String

ID of the Thread to subscribe

public void subscribeForMessageEvents(
String threadId
)

subscribeForThreadEvents

Subscribes for the Thread module main events.

public void subscribeForThreadEvents()

unsubscribeFromMessageEvents

Unsubscribes from events in given Thread.

Params

threadId

String

ID of the Thread to unsubscribe

public void unsubscribeFromMessageEvents(
String threadId
)

unsubscribeFromThreadEvents

Unsubscribes from the Thread module main events.

public void unsubscribeFromThreadEvents()

updateMessage

Updates message in a Thread.

Params

messageId

String

ID of the message to update

publicMeta

byte[]

public message metadata

privateMeta

byte[]

private message metadata

data

byte[]

new content of the message

public void updateMessage(
String messageId,
byte[] publicMeta,
byte[] privateMeta,
byte[] data
)

updateThread

Updates an existing Thread.

Params

threadId

String

ID of the Thread to update

users

List<UserWithPubKey>

list of UserWithPubKey which indicates who will have access to the updated Thread

managers

List<UserWithPubKey>

list of UserWithPubKey which indicates who will have access (and management rights) to the updated Thread

publicMeta

byte[]

public (unencrypted) metadata

privateMeta

byte[]

private (encrypted) metadata

version

long

current version of the updated Thread

force

boolean

force update (without checking version)

public void updateThread(
String threadId,
List<UserWithPubKey> users,
List<UserWithPubKey> managers,
byte[] publicMeta,
byte[] privateMeta,
long version,
boolean force
)

updateThread

Updates an existing Thread.

Params

threadId

String

ID of the Thread to update

users

List<UserWithPubKey>

list of UserWithPubKey which indicates who will have access to the updated Thread

managers

List<UserWithPubKey>

list of UserWithPubKey which indicates who will have access (and management rights) to the updated Thread

publicMeta

byte[]

public (unencrypted) metadata

privateMeta

byte[]

private (encrypted) metadata

version

long

current version of the updated Thread

force

boolean

force update (without checking version)

forceGenerateNewKey

boolean

force to regenerate a key for the Thread

public void updateThread(
String threadId,
List<UserWithPubKey> users,
List<UserWithPubKey> managers,
byte[] publicMeta,
byte[] privateMeta,
long version,
boolean force,
boolean forceGenerateNewKey
)

updateThread

Updates an existing Thread.

Params

threadId

String

ID of the Thread to update

users

List<UserWithPubKey>

list of UserWithPubKey which indicates who will have access to the updated Thread

managers

List<UserWithPubKey>

list of UserWithPubKey which indicates who will have access (and management rights) to the updated Thread

publicMeta

byte[]

public (unencrypted) metadata

privateMeta

byte[]

private (encrypted) metadata

version

long

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

additional container access policies

public void updateThread(
String threadId,
List<UserWithPubKey> users,
List<UserWithPubKey> managers,
byte[] publicMeta,
byte[] privateMeta,
long version,
boolean force,
boolean forceGenerateNewKey,
ContainerPolicy policies
)