matrix-sdk-android/org.matrix.android.sdk.api.session.room.timeline/Timeline

Timeline

interface Timeline

A Timeline instance represents a contiguous sequence of events in a room.

There are two kinds of timeline:

- live timelines: they process live events from the sync. You can paginate backwards but not forwards.

- past timelines: they start in the past from an `initialEventId`. You can paginate backwards and forwards.

Types

enum Direction : Enum<Timeline.Direction>

This is used to paginate in one or another direction.

interface Listener

PaginationState

data class PaginationState( val hasMoreToLoad: Boolean = true, val loading: Boolean = false, val inError: Boolean = false)

Pagination state.

Functions

abstract fun addListener(listener: Timeline.Listener): Boolean

abstract suspend fun awaitPaginate(direction: Timeline.Direction, count: Int): List<TimelineEvent>

This is the same than the regular paginate method but waits for the results instead of relying on the timeline listener.

abstract fun dispose()

This must be called when you don't need the timeline. It ensures the underlying database get closed.

getIndexOfEvent

abstract fun getIndexOfEvent(eventId: String?): Int?

Returns the index of a built event or null.

getPaginationState

abstract fun getPaginationState(direction: Timeline.Direction): Timeline.PaginationState

Returns the current pagination state for the direction.

abstract fun getSnapshot(): List<TimelineEvent>

Returns a snapshot of the timeline in his current state.

abstract fun hasMoreToLoad(direction: Timeline.Direction): Boolean

Check if the timeline can be enriched by paginating.

abstract fun paginate(direction: Timeline.Direction, count: Int)

This is the main method to enrich the timeline with new data. It will call the onTimelineUpdated method from Listener when the data will be processed. It also ensures only one pagination by direction is launched at a time, so you can safely call this multiple time in a row.

removeAllListeners

abstract fun removeAllListeners()

abstract fun removeListener(listener: Timeline.Listener): Boolean

restartWithEventId

abstract fun restartWithEventId(eventId: String?)

This method restarts the timeline, erases all built events and pagination states. It then loads events around the eventId. If eventId is null, it does restart the live timeline.

abstract fun start(rootThreadEventId: String? = null)

This must be called before any other method after creating the timeline. It ensures the underlying database is open

Properties

abstract val isLive: Boolean

abstract val timelineID: String