Timeline

interface Timeline<T>

This is an abstraction for a timeline. Call init first!

Properties

abstract val state: Flow<TimelineState<T>>

The current state of the timeline.

abstract suspend fun dropAfter(roomId: RoomId, eventId: EventId): TimelineStateChange<T>

Drop all events after a given eventId.

abstract suspend fun dropBefore(roomId: RoomId, eventId: EventId): TimelineStateChange<T>

Drop all events before a given eventId.

abstract suspend fun init(roomId: RoomId, startFrom: EventId, configStart: GetTimelineEventConfig.() -> Unit = {}, configBefore: GetTimelineEventsConfig.() -> Unit = {}, configAfter: GetTimelineEventsConfig.() -> Unit = {}): TimelineStateChange<T>

Initialize the timeline with the start event.

Load new events after the newest event. With default config this may suspend until at least one event can be loaded.

Load new events before the oldest event. With default config this may suspend until at least one event can be loaded.