summary refs log tree commit diff
path: root/synapse/storage/room.py
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2019-03-20 17:49:56 +0000
committerErik Johnston <erik@matrix.org>2019-03-20 17:49:56 +0000
commit8d8834d3e7d6c0c4086ea47664c922bfa91757d4 (patch)
tree21b0a1ce3946d66ed74315546c9d38c9e9fb5e4a /synapse/storage/room.py
parentUse flags (diff)
downloadsynapse-8d8834d3e7d6c0c4086ea47664c922bfa91757d4.tar.xz
comment block_room
Diffstat (limited to 'synapse/storage/room.py')
-rw-r--r--synapse/storage/room.py9
1 files changed, 9 insertions, 0 deletions
diff --git a/synapse/storage/room.py b/synapse/storage/room.py
index 33870b585e..abc9786a99 100644
--- a/synapse/storage/room.py
+++ b/synapse/storage/room.py
@@ -500,6 +500,15 @@ class RoomStore(RoomWorkerStore, SearchStore):
 
     @defer.inlineCallbacks
     def block_room(self, room_id, user_id):
+        """Marks the room as blocked. Can be called multiple times.
+
+        Args:
+            room_id (str): Room to block
+            user_id (str): Who blocked it
+
+        Returns:
+            Deferred
+        """
         yield self._simple_upsert(
             table="blocked_rooms",
             keyvalues={