From 4fc6ba884e166cccf7c0af18e01e5f8c7056fa6b Mon Sep 17 00:00:00 2001 From: Timo <16718859+toger5@users.noreply.github.com> Date: Wed, 17 Apr 2024 12:28:40 +0200 Subject: [PATCH] add comment to make clear that RoomStateEvent.Events does not update related objects in the js-sdk (#4152) Signed-off-by: Timo K --- src/models/room-state.ts | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/models/room-state.ts b/src/models/room-state.ts index 745b2a5aa44..b6f4d074425 100644 --- a/src/models/room-state.ts +++ b/src/models/room-state.ts @@ -78,6 +78,8 @@ export enum RoomStateEvent { export type RoomStateEventHandlerMap = { /** * Fires whenever the event dictionary in room state is updated. + * This does not guarantee that any related objects (like RoomMember) have been updated. + * Use RoomStateEvent.Update for that. * @param event - The matrix event which caused this event to fire. * @param state - The room state whose RoomState.events dictionary * was updated.