Skip to content

Commit d45595c

Browse files
committedOct 15, 2024
Document args of delayed events store method
1 parent 55e613b commit d45595c

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed
 

‎synapse/storage/databases/main/delayed_events.py

+7
Original file line numberDiff line numberDiff line change
@@ -429,6 +429,13 @@ async def cancel_delayed_state_events(
429429
"""
430430
Cancels all matching delayed state events, i.e. remove them as long as they haven't been processed.
431431
432+
Args:
433+
room_id: The room ID to match against.
434+
event_type: The event type to match against.
435+
state_key: The state key to match against.
436+
not_from_localpart: The localpart of a user whose delayed events to not cancel.
437+
If set to the empty string, any users' delayed events may be cancelled.
438+
432439
Returns: The send time of the next delayed event to be sent, if any.
433440
"""
434441

0 commit comments

Comments
 (0)