mirror of
https://git.anonymousland.org/anonymousland/synapse-product.git
synced 2024-09-08 12:41:53 +00:00
docstring for get_current_state_ids
This commit is contained in:
parent
d413a2ba98
commit
adfc0c9539
@ -147,6 +147,19 @@ class StateHandler(object):
|
||||
|
||||
@defer.inlineCallbacks
|
||||
def get_current_state_ids(self, room_id, latest_event_ids=None):
|
||||
"""Get the current state, or the state at a set of events, for a room
|
||||
|
||||
Args:
|
||||
room_id (str):
|
||||
|
||||
latest_event_ids (iterable[str]|None): if given, the forward
|
||||
extremities to resolve. If None, we look them up from the
|
||||
database (via a cache)
|
||||
|
||||
Returns:
|
||||
Deferred[dict[(str, str), str)]]: the state dict, mapping from
|
||||
(event_type, state_key) -> event_id
|
||||
"""
|
||||
if not latest_event_ids:
|
||||
latest_event_ids = yield self.store.get_latest_event_ids_in_room(room_id)
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user