SlidingSyncEvent
Defined in: src/sliding-sync.ts:264
Events which can be fired by the SlidingSync class. These are designed to provide different levels of information when processing sync responses.
- RoomData: concerns rooms, useful for SlidingSyncSdk to update its knowledge of rooms.
- Lifecycle: concerns callbacks at various well-defined points in the sync process. Specifically, the order of event invocation is:
- Lifecycle (state=RequestFinished)
- RoomData (N times)
- Lifecycle (state=Complete)
Enumeration Members
Section titled “Enumeration Members”Lifecycle
Section titled “Lifecycle”Lifecycle:
"SlidingSync.Lifecycle"
Defined in: src/sliding-sync.ts:277
This event fires at various points in the /sync loop lifecycle.
- SlidingSyncState.RequestFinished: Fires after we receive a valid response but before the
response has been processed. Perform any pre-process steps here. If there was a problem syncing,
errwill be set (e.g network errors). - SlidingSyncState.Complete: Fires after the response has been processed.
RoomData
Section titled “RoomData”RoomData:
"SlidingSync.RoomData"
Defined in: src/sliding-sync.ts:269
This event fires when there are updates for a room. Fired as and when rooms are encountered in the response.