From a29b5204e0c6249410e177a2baebebc4b0c0549f Mon Sep 17 00:00:00 2001 From: Hubert Chathi Date: Thu, 15 Dec 2022 20:43:36 -0500 Subject: [PATCH] add hint about receiving unrenderable events --- data/api/client-server/room_event_by_timestamp.yaml | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/data/api/client-server/room_event_by_timestamp.yaml b/data/api/client-server/room_event_by_timestamp.yaml index cfb12c45..7b360921 100644 --- a/data/api/client-server/room_event_by_timestamp.yaml +++ b/data/api/client-server/room_event_by_timestamp.yaml @@ -43,6 +43,18 @@ paths: After calling this endpoint, clients can call [`/rooms/{roomId}/context/{eventId}`](#get_matrixclientv3roomsroomidcontexteventid) to obtain a pagination token to retrieve the events around the returned event. + + The event returned by this endpoint could be an event that the client + cannot render, and so may need to paginate in order to locate an event + that it can display, which may end up being outside of the client's + suitable range. Clients can employ different strategies to display + something reasonable to the user. For example, the client could try + paginating in one direction for a while, while looking at the + timestamps of the events that it is paginating through, and if it + exceeds a certain difference from the target timestamp, it can try + paginating in the opposite direction. The client could also simply + paginate in one direction and inform the user that the closest event + found in that direction is outside of the expected range. operationId: getEventByTimestamp security: - accessToken: []