matrix-sdk-android/org.matrix.android.sdk.api.session.room.read/ReadService

ReadService

interface ReadService
Content copied to clipboard

This interface defines methods to handle read receipts and read marker in a room. It's implemented at the room level.

Types

Link copied to clipboard
object Companion
Content copied to clipboard
Link copied to clipboard
enum MarkAsReadParams : Enum<ReadService.MarkAsReadParams>
Content copied to clipboard

Functions

Link copied to clipboard
abstract fun getEventReadReceiptsLive(eventId: String): LiveData<List<ReadReceipt>>
Content copied to clipboard

Returns a live list of read receipts for a given event.

Link copied to clipboard
abstract fun getMyReadReceiptLive(threadId: String?): LiveData<Optional<String>>
Content copied to clipboard

Returns a live read receipt id for the room.

Link copied to clipboard
abstract fun getReadMarkerLive(): LiveData<Optional<String>>
Content copied to clipboard

Returns a live read marker id for the room.

Link copied to clipboard
abstract fun getUserReadReceipt(userId: String): String?
Content copied to clipboard

Get the eventId from the main timeline where the read receipt for the provided user is.

Link copied to clipboard
abstract fun isEventRead(eventId: String): Boolean
Content copied to clipboard

Check if an event is already read, ie. your read receipt is set on a more recent event.

Link copied to clipboard
abstract suspend fun markAsRead(params: ReadService.MarkAsReadParams = MarkAsReadParams.BOTH, mainTimeLineOnly: Boolean = true)
Content copied to clipboard

Force the read marker to be set on the latest event.

Link copied to clipboard
abstract suspend fun setReadMarker(fullyReadEventId: String)
Content copied to clipboard

Set the read marker on the event with provided eventId.

Link copied to clipboard
abstract suspend fun setReadReceipt(eventId: String, threadId: String)
Content copied to clipboard

Set the read receipt on the event with provided eventId.