Add documentation on new API.

This commit is contained in:
Benoit Marty
2024-04-29 14:16:12 +02:00
parent 65db3d597a
commit c75995f925

View File

@@ -98,8 +98,15 @@ interface MatrixRoom : Closeable {
val syncUpdateFlow: StateFlow<Long>
/**
* The live timeline of the room. Must be used to send Event to a room.
*/
val liveTimeline: Timeline
/**
* Create a new timeline, focused on the provided Event.
* Should not be used directly, see `TimelineController` to manage the various timelines.
*/
suspend fun timelineFocusedOnEvent(eventId: EventId): Result<Timeline>
fun destroy()