Explain the semantics of SetLatestEvents a bit?

This commit is contained in:
Mark Haines 2017-02-21 13:50:26 +00:00
parent 2cce7c9f66
commit f70d0d4819

View file

@ -138,6 +138,7 @@ type RoomRecentEventsUpdater interface {
// Check whether the eventReference is already referenced by another matrix event. // Check whether the eventReference is already referenced by another matrix event.
IsReferenced(eventReference gomatrixserverlib.EventReference) (bool, error) IsReferenced(eventReference gomatrixserverlib.EventReference) (bool, error)
// Set the list of latest events for the room. // Set the list of latest events for the room.
// This replaces the current list stored in the database with the given list.
SetLatestEvents(roomNID RoomNID, latest []StateAtEventAndReference) error SetLatestEvents(roomNID RoomNID, latest []StateAtEventAndReference) error
// Commit the transaction // Commit the transaction
Commit() error Commit() error