dandri/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse.git synced 2026-05-23 00:15:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Move SlidingSyncInterestedRooms attributes docs to attributes

Browse Source
This commit is contained in:
Olivier 'reivilibre
2026-04-07 12:03:17 +01:00
parent 47c930f0b7
commit 37412f4c20
1 changed files with 30 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
synapse/handlers/sliding_sync/room_lists.py
+30 -14
View File
@@ -112,31 +112,47 @@ class SlidingSyncInterestedRooms:
sliding sync request.
Returned by `compute_interested_rooms`.
Attributes:
lists: A mapping from list name to the list result for the response
relevant_room_map: A map from rooms that match the sync request to
their room sync config.
relevant_rooms_to_send_map: Subset of `relevant_room_map` that
includes the rooms that *may* have relevant updates. Rooms not
in this map will definitely not have room updates (though
extensions may have updates in these rooms).
newly_joined_rooms: The set of rooms that were joined in the token range
and the user is still joined to at the end of this range.
newly_left_rooms: The set of rooms that we left in the token range
and are still "leave" at the end of this range.
dm_room_ids: The set of rooms the user consider as direct-message (DM) rooms
"""
lists: Mapping[str, SlidingSyncResult.SlidingWindowList]
"""
A mapping from list name to the list result for the response
"""
relevant_room_map: Mapping[str, RoomSyncConfig]
"""
A map from rooms that match the sync request to
their room sync config.
"""
relevant_rooms_to_send_map: Mapping[str, RoomSyncConfig]
"""
Subset of `relevant_room_map` that
includes the rooms that *may* have relevant updates. Rooms not
in this map will definitely not have room updates (though
extensions may have updates in these rooms).
"""
all_rooms: set[str]
room_membership_for_user_map: Mapping[str, RoomsForUserType]
newly_joined_rooms: AbstractSet[str]
"""
The set of rooms that were joined in the token range
and the user is still joined to at the end of this range.
"""
newly_left_rooms: AbstractSet[str]
"""
The set of rooms that we left in the token range
and are still "leave" at the end of this range.
"""
dm_room_ids: AbstractSet[str]
"""
The set of rooms the user consider as direct-message (DM) rooms
"""
@staticmethod
def empty() -> "SlidingSyncInterestedRooms":