Interface SyncApiOptions

Options passed into the constructor of SyncApi by MatrixClient

interface SyncApiOptions {
    canResetEntireTimeline?: ResetTimelineCallback;
    cryptoCallbacks?: SyncCryptoCallbacks;
}

Properties

canResetEntireTimeline? cryptoCallbacks?

Properties

OptionalcanResetEntireTimeline

canResetEntireTimeline?: ResetTimelineCallback

A function which is called with a room ID and returns a boolean. It should return 'true' if the SDK can SAFELY remove events from this room. It may not be safe to remove events if there are other references to the timelines for this room.

OptionalcryptoCallbacks

cryptoCallbacks?: SyncCryptoCallbacks

If crypto is enabled on our client, callbacks into the crypto module

Settings

Member Visibility

On This Page

Properties