Interface SyncCryptoCallbacks`Internal`

The methods which crypto implementations should expose to the Sync api

interface SyncCryptoCallbacks {
    onCryptoEvent(room, event): Promise<void>;
    onSyncCompleted(syncState): void;
    preprocessToDeviceMessages(events): Promise<IToDeviceEvent[]>;
    processDeviceLists(deviceLists): Promise<void>;
    processKeyCounts(oneTimeKeysCounts?, unusedFallbackKeys?): Promise<void>;
}

Hierarchy (view full)

SyncCryptoCallbacks
- CryptoBackend

Index

Methods

onCryptoEvent onSyncCompleted preprocessToDeviceMessages processDeviceLists processKeyCounts

Methods

onCryptoEvent

onCryptoEvent(room, event): Promise<void>
Called by the /sync loop whenever an m.room.encryption event is received.

This is called before RoomStateEvents are emitted for any of the events in the /sync response (even if the other events technically happened first). This works around a problem if the client uses a RoomStateEvent (typically a membership event) as a trigger to send a message in a new room (or one where encryption has been newly enabled): that would otherwise leave the crypto layer confused because it expects crypto to be set up, but it has not yet been.
Parameters
- room: Room
  in which the event was received
- event: MatrixEvent
  encryption event to be processed
Returns Promise<void>
- Defined in src/common-crypto/CryptoBackend.ts:169

onSyncCompleted

onSyncCompleted(syncState): void
Called by the /sync loop after each /sync response is processed.

Used to complete batch processing, or to initiate background processes
Parameters
- syncState: OnSyncCompletedData
  information about the completed sync.
Returns void
- Defined in src/common-crypto/CryptoBackend.ts:178

preprocessToDeviceMessages

preprocessToDeviceMessages(events): Promise<IToDeviceEvent[]>
Called by the /sync loop whenever there are incoming to-device messages.

The implementation may preprocess the received messages (eg, decrypt them) and return an updated list of messages for dispatch to the rest of the system.

Note that, unlike ClientEvent.ToDeviceEvent events, this is called on the raw to-device messages, rather than the results of any decryption attempts.
Parameters
- events: IToDeviceEvent[]
  the received to-device messages
Returns Promise<IToDeviceEvent[]>
A list of preprocessed to-device messages.
- Defined in src/common-crypto/CryptoBackend.ts:139

processDeviceLists

processDeviceLists(deviceLists): Promise<void>
Handle the notification from /sync that device lists have been changed.
Parameters
- deviceLists: IDeviceLists
  device_lists field from /sync
Returns Promise<void>
- Defined in src/common-crypto/CryptoBackend.ts:155

processKeyCounts

processKeyCounts(oneTimeKeysCounts?, unusedFallbackKeys?): Promise<void>
Called by the /sync loop when one time key counts and unused fallback key details are received.
Parameters
- Optional oneTimeKeysCounts: Record<string, number>
  the received one time key counts
- Optional unusedFallbackKeys: string[]
  the received unused fallback keys
Returns Promise<void>
- Defined in src/common-crypto/CryptoBackend.ts:147

Generated using TypeDoc