matrix-js-sdk
    Preparing search index...

    Interface SyncCryptoChangesInternal

    The parts of a sync response which are relevant to encryption, as passed to SyncCryptoCallbacks.processSyncChanges.

    interface SyncCryptoChanges {
        deviceLists?: IDeviceLists;
        oneTimeKeysCounts?: Record<string, number>;
        toDeviceEvents: IToDeviceEvent[];
        unusedFallbackKeys?: string[];
        useMsc4186?: boolean;
    }
    Index
    deviceLists? oneTimeKeysCounts? toDeviceEvents unusedFallbackKeys? useMsc4186?
    deviceLists?: IDeviceLists

    The device_lists field from the sync response, if any.

    oneTimeKeysCounts?: Record<string, number>

    The device_one_time_keys_count field from the sync response, if any.

    The meaning of an algorithm missing from the map (or of an absent field) depends on useMsc4186: in sync v2 it means that there are no one-time keys of that algorithm on the server; in sliding sync it means that the count is unchanged since the previous response.

    toDeviceEvents: IToDeviceEvent[]

    The to-device events from the sync response (to_device.events), or an empty list if there were none.

    unusedFallbackKeys?: string[]

    The device_unused_fallback_key_types field from the sync response, or undefined if the response did not include it (which means that the server does not support fallback keys).

    useMsc4186?: boolean

    Whether to interpret the response with MSC4186 (simplified sliding sync) semantics rather than sync v2. This selects the meaning of missing one-time key counts: see oneTimeKeysCounts. Defaults to false.

    Settings
    Member Visibility

    On This Page
    Properties