MirrorHub/synapse
0
0
Fork 1
mirror of https://mau.dev/maunium/synapse.git synced 2024-10-30 11:18:54 +01:00
Code Issues Projects Releases Wiki Activity

Doc string for the SyncHandler.typing_by_room method

Browse source
This commit is contained in:
Mark Haines 2015-10-21 15:45:37 +01:00
parent 7be06680ed
commit d63a0ca34b
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
synapse/handlers/sync.py
View file

@ -211,6 +211,18 @@ class SyncHandler(BaseHandler):
@defer.inlineCallbacks
def typing_by_room(self, sync_config, now_token, since_token=None):
"""Get the typing events for each room the user is in
Args:
sync_config (SyncConfig): The flags, filters and user for the sync.
now_token (StreamToken): Where the server is currently up to.
since_token (StreamToken): Where the server was when the client
last synced.
Returns:
A tuple of the now StreamToken, updated to reflect the which typing
events are included, and a dict mapping from room_id to a list of
typing events for that room.
"""
typing_key = since_token.typing_key if since_token else "0"
typing_source = self.event_sources.sources["typing"]