1
0
mirror of https://github.com/matrix-org/matrix-js-sdk.git synced 2025-08-09 10:22:46 +03:00

add comment to make clear that RoomStateEvent.Events does not update related objects in the js-sdk (#4152)

Signed-off-by: Timo K <toger5@hotmail.de>
This commit is contained in:
Timo
2024-04-17 12:28:40 +02:00
committed by GitHub
parent c30e498013
commit 4fc6ba884e

View File

@@ -78,6 +78,8 @@ export enum RoomStateEvent {
export type RoomStateEventHandlerMap = { export type RoomStateEventHandlerMap = {
/** /**
* Fires whenever the event dictionary in room state is updated. * 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 event - The matrix event which caused this event to fire.
* @param state - The room state whose RoomState.events dictionary * @param state - The room state whose RoomState.events dictionary
* was updated. * was updated.