1 files changed, 16 insertions, 2 deletions
diff --git a/synapse/notifier.py b/synapse/notifier.py
index 1a9f84ba45..1acd899fab 100644
--- a/synapse/notifier.py
+++ b/synapse/notifier.py
@@ -379,7 +379,14 @@ class Notifier:
stream_key: str,
new_token: Union[int, RoomStreamToken],
users: Optional[Collection[Union[str, UserID]]] = None,
- ):
+ ) -> None:
+ """Notify application services of ephemeral event activity.
+
+ Args:
+ stream_key: The stream the event came from.
+ new_token: The value of the new stream token.
+ users: The users that should be informed of the new event, if any.
+ """
try:
stream_token = None
if isinstance(new_token, int):
@@ -402,10 +409,17 @@ class Notifier:
new_token: Union[int, RoomStreamToken],
users: Optional[Collection[Union[str, UserID]]] = None,
rooms: Optional[Collection[str]] = None,
- ):
+ ) -> None:
"""Used to inform listeners that something has happened event wise.
Will wake up all listeners for the given users and rooms.
+
+ Args:
+ stream_key: The stream the event came from.
+ new_token: The value of the new stream token.
+ users: The users that should be informed of the new event.
+ rooms: A collection of room IDs for which each joined member will be
+ informed of the new event.
"""
users = users or []
rooms = rooms or []
|