Timeline

interface Timeline

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

Functions

abstract suspend fun init(startFrom: EventId): List<Flow<TimelineEvent>>

Initialize the timeline with the start event.

abstract suspend fun loadAfter(): List<Flow<TimelineEvent>>

Load new events after the newest event. This may suspend until at least one event can be loaded.

abstract suspend fun loadBefore(): List<Flow<TimelineEvent>>

Load new events before the oldest event. This may suspend until at least one event can be loaded.

abstract val canLoadAfter: Flow<Boolean>

Is true until last known TimelineEvent is reached.

abstract val canLoadBefore: Flow<Boolean>

Is true until start of timeline is reached.

abstract val events: Flow<List<Flow<TimelineEvent>>>

TimelineEvents sorted with higher indexes being more recent.

abstract val isInitialized: Flow<Boolean>

True when timeline initialization has been finished.

True while events are loaded after.

True while events are loaded before.

abstract val lastLoadedEventIdAfter: Flow<EventId?>

Upper bound of loaded events in this timeline.

abstract val lastLoadedEventIdBefore: Flow<EventId?>

Lower bound of loaded events in this timeline.