summary refs log tree commit diff
path: root/synapse/storage/state.py
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2017-03-20 17:25:41 +0000
committerErik Johnston <erik@matrix.org>2017-03-20 17:25:41 +0000
commite0e214556a82370528ef1f9943773c42270c5336 (patch)
tree7fcbb016a63202eb1733e6b69a4999ba94193e8c /synapse/storage/state.py
parentMerge pull request #2028 from majewsky/readme-fix-1 (diff)
parentBump changelog and version (diff)
downloadsynapse-e0e214556a82370528ef1f9943773c42270c5336.tar.xz
Merge branch 'release-v0.19.3' of github.com:matrix-org/synapse v0.19.3
Diffstat (limited to 'synapse/storage/state.py')
-rw-r--r--synapse/storage/state.py14
1 files changed, 13 insertions, 1 deletions
diff --git a/synapse/storage/state.py b/synapse/storage/state.py
index 1b3800eb6a..84482d8285 100644
--- a/synapse/storage/state.py
+++ b/synapse/storage/state.py
@@ -413,7 +413,19 @@ class StateStore(SQLBaseStore):
         defer.returnValue({event: event_to_state[event] for event in event_ids})
 
     @defer.inlineCallbacks
-    def get_state_ids_for_events(self, event_ids, types):
+    def get_state_ids_for_events(self, event_ids, types=None):
+        """
+        Get the state dicts corresponding to a list of events
+
+        Args:
+            event_ids(list(str)): events whose state should be returned
+            types(list[(str, str)]|None): List of (type, state_key) tuples
+                which are used to filter the state fetched. May be None, which
+                matches any key
+
+        Returns:
+            A deferred dict from event_id -> (type, state_key) -> state_event
+        """
         event_to_groups = yield self._get_state_group_for_events(
             event_ids,
         )