From ed0d255495c7c6a04bb4e8d2b7f26bc28f415268 Mon Sep 17 00:00:00 2001
From: Benoit Marty <benoitm@matrix.org>
Date: Thu, 20 Oct 2022 14:03:42 +0200
Subject: [PATCH] Quick improvement on the doc.

---
 .../matrix/android/sdk/api/session/room/timeline/Timeline.kt    | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/timeline/Timeline.kt b/matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/timeline/Timeline.kt
index 1824d5dc6c..9ac33c0545 100644
--- a/matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/timeline/Timeline.kt
+++ b/matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/timeline/Timeline.kt
@@ -106,6 +106,8 @@ interface Timeline {
 
         /**
          * Called when new events come through the sync.
+         * Note that the corresponding events may not be available yet in the database.
+         * [onTimelineUpdated] will be called with the event content.
          */
         fun onNewTimelineEvents(eventIds: List<String>) = Unit