Doc we raise on unknown event

This commit is contained in:
Erik Johnston 2018-04-12 11:20:51 +01:00
parent d7bf3a68f0
commit 23a7f9d7f4
1 changed files with 3 additions and 2 deletions

View File

@ -52,13 +52,14 @@ _EventCacheEntry = namedtuple("_EventCacheEntry", ("event", "redacted_event"))
class EventsWorkerStore(SQLBaseStore):
def get_received_ts(self, event_id):
"""Get received_ts (when it was persisted) for the event
"""Get received_ts (when it was persisted) for the event. Raises an
exception for unknown events.
Args:
event_id (str)
Returns:
Deferred[int|None]: Timstamp in milliseconds, or None for events
Deferred[int|None]: Timestamp in milliseconds, or None for events
that were persisted before received_ts was implemented.
"""
return self._simple_select_one_onecol(