markRead

js
suspend fun markRead(to: <ERROR CLASS>, timestamps: Iterable<Long>, when: Long = Clock.System.now().toEpochMilliseconds())

Marks the given messages (represented as timestamps) as read. Note that messages are identified using their timestamps.

Parameters

to

The address that sent the messages that will be marked as read.

timestamps

The timestamps of the messages we want to mark as read.

when

The timestamp to use for when we mark as read. Defaults to the current system clock's timestamp.

Throws

RequestFailedException

if signald sends an error response or the incoming message is invalid

SignaldException

if the request to the socket fails

synchronousClient
fun markRead(to: JsonAddress, timestamps: Iterable<Long>, when: Long = Clock.System.now().toEpochMilliseconds())

Marks the given messages (represented as timestamps) as read. Note that messages are identified using their timestamps.

Parameters

to

The address that sent the messages that will be marked as read.

timestamps

The timestamps of the messages we want to mark as read.

when

The timestamp to use for when we mark as read. Defaults to the current system clock's timestamp.

Throws

org.inthewaves.kotlinsignald.clientprotocol.RequestFailedException

if signald sends an error response or the incoming message is invalid

org.inthewaves.kotlinsignald.clientprotocol.SignaldException

if the request to the socket fails