Interface SyncStateData

interface SyncStateData {
    catchingUp?: boolean;
    error?: Error;
    fromCache?: boolean;
    nextSyncToken?: string;
    oldSyncToken?: string;
}

Properties

catchingUp? error? fromCache? nextSyncToken? oldSyncToken?

Properties

Optional catchingUp

catchingUp?: boolean

True if we are working our way through a backlog of events after connecting. Only present if state=SYNCING.

Optional error

error?: Error

The matrix error if state=ERROR.

Optional fromCache

fromCache?: boolean

Optional nextSyncToken

nextSyncToken?: string

The 'next_batch' result from /sync, which will become the 'since' token for the next call to /sync. Only present if state=PREPARED</code> or <code>state=SYNCING.

Optional oldSyncToken

oldSyncToken?: string

The 'since' token passed to /sync. null for the first successful sync since this client was started. Only present if state=PREPARED or state=SYNCING.

Settings

Member Visibility

Theme

On This Page

catchingUperrorfromCachenextSyncTokenoldSyncToken

Generated using TypeDoc