summary refs log tree commit diff
path: root/synapse/handlers/federation.py
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2018-06-25 19:57:38 +0100
committerErik Johnston <erik@matrix.org>2018-06-25 19:57:38 +0100
commita0e8a53c6d0ff65629aa8645d43df06558ff88af (patch)
treee48a16a2f2254a9a1359a42860f81f24dc18b2f5 /synapse/handlers/federation.py
parentFix bug with assuming wrong type (diff)
downloadsynapse-a0e8a53c6d0ff65629aa8645d43df06558ff88af.tar.xz
Comment
Diffstat (limited to 'synapse/handlers/federation.py')
-rw-r--r--synapse/handlers/federation.py8
1 files changed, 8 insertions, 0 deletions
diff --git a/synapse/handlers/federation.py b/synapse/handlers/federation.py
index aab69550a0..c4ffdf887e 100644
--- a/synapse/handlers/federation.py
+++ b/synapse/handlers/federation.py
@@ -460,6 +460,14 @@ class FederationHandler(BaseHandler):
     @measure_func("_filter_events_for_server")
     @defer.inlineCallbacks
     def _filter_events_for_server(self, server_name, room_id, events):
+        """Filter the given events for the given server, redacting those the
+        server can't see.
+
+        Assumes the server is currently in the room.
+
+        Returns
+            list[FrozenEvent]
+        """
         # First lets check to see if all the events have a history visibility
         # of "shared" or "world_readable". If thats the case then we don't
         # need to check membership (as we know the server is in the room).