Class SyncApi

Hierarchy

SyncApi

Constructors

constructor

new SyncApi(client: MatrixClient, opts?: IStoredClientOpts, syncOpts?: SyncApiOptions): SyncApi
Internal
Construct an entity which is able to sync with a homeserver.
Parameters
- client: MatrixClient
  
  The matrix client instance to use.
- Optional opts: IStoredClientOpts
  
  client config options
- Optional syncOpts: SyncApiOptions
  
  sync-specific options passed by the client
Returns SyncApi
- Defined in src/sync.ts:236

Properties

`Private` _peekRoom

_peekRoom: Optional<Room> = null

`Private` `Optional` abortController

abortController?: AbortController

`Private` catchingUp

catchingUp: boolean = false

`Private` `Readonly` client

client: MatrixClient

The matrix client instance to use.

`Private` `Optional` connectionReturnedDefer

connectionReturnedDefer?: IDeferred<boolean>

`Private` `Optional` currentSyncRequest

currentSyncRequest?: Promise<ISyncResponse>

`Private` failedSyncCount

failedSyncCount: number = 0

`Private` `Optional` keepAliveTimer

keepAliveTimer?: Timeout

`Private` notifEvents

notifEvents: MatrixEvent[] = []

`Private` `Readonly` opts

opts: IStoredClientOpts

`Private` running

running: boolean = false

`Private` `Optional` savedSyncPromise

savedSyncPromise?: Promise<void>

`Private` storeIsInvalid

storeIsInvalid: boolean = false

`Private` `Readonly` syncOpts

syncOpts: SyncApiOptions

`Private` syncState

syncState: null | SyncState = null

`Private` `Optional` syncStateData

syncStateData?: ISyncStateData

Methods

`Private` buildDefaultFilter

buildDefaultFilter(): Filter
Returns Filter
- Defined in src/sync.ts:634

`Private` checkLazyLoadStatus

checkLazyLoadStatus(): Promise<void>
Returns Promise<void>
- Defined in src/sync.ts:642

createRoom

createRoom(roomId: string): Room
Parameters
- roomId: string
Returns Room
- Defined in src/sync.ts:245

`Private` doSync

doSync(syncOptions: ISyncOptions): Promise<void>
Invoke me to do /sync calls
Parameters
- syncOptions: ISyncOptions
Returns Promise<void>
- Defined in src/sync.ts:876

`Private` doSyncRequest

doSyncRequest(syncOptions: ISyncOptions, syncToken: null | string): Promise<ISyncResponse>
Parameters
- syncOptions: ISyncOptions
- syncToken: null | string
Returns Promise<ISyncResponse>
- Defined in src/sync.ts:970

`Private` getFilter

getFilter(): Promise<{
filter?: Filter;
filterId?: string;
}>
Returns Promise<{
filter?: Filter;
filterId?: string;
}>
- Defined in src/sync.ts:688

`Private` getGuestFilter

getGuestFilter(): string
Returns string
- Defined in src/sync.ts:1803

`Private` getPushRules

getPushRules(): Promise<void>
Returns Promise<void>
- Defined in src/sync.ts:616

`Private` getSyncParams

getSyncParams(syncOptions: ISyncOptions, syncToken: null | string): ISyncParams
Parameters
- syncOptions: ISyncOptions
- syncToken: null | string
Returns ISyncParams
- Defined in src/sync.ts:978

getSyncState

getSyncState(): null | SyncState
Returns the current state of this sync object

See
MatrixClient#event:"sync"

Returns null | SyncState
- Defined in src/sync.ts:560

getSyncStateData

getSyncStateData(): null | ISyncStateData
Returns the additional data object associated with the current sync state, or null if there is no such data. Sync errors, if available, are put in the 'error' key of this object.

Returns null | ISyncStateData
- Defined in src/sync.ts:571

injectRoomEvents

injectRoomEvents(room: Room, stateEventList: MatrixEvent[], timelineEventList?: MatrixEvent[], fromCache?: boolean): Promise<void>
Injects events into a room's model.
Parameters
- room: Room
- stateEventList: MatrixEvent[]
  
  A list of state events. This is the state at the START of the timeline list if it is supplied.
- Optional timelineEventList: MatrixEvent[]
  
  A list of timeline events, including threaded. Lower index is earlier in time. Higher index is later.
- fromCache: boolean = false
  
  whether the sync response came from cache
Returns Promise<void>
- Defined in src/sync.ts:1714

`Private` mapSyncEventsFormat

mapSyncEventsFormat(obj: IEphemeral | ITimeline | IInviteState, room?: Room, decrypt?: boolean): MatrixEvent[]
Parameters
- obj: IEphemeral | ITimeline | IInviteState
- Optional room: Room
- decrypt: boolean = true
Returns MatrixEvent[]
- Defined in src/sync.ts:1643

`Private` mapSyncResponseToRoomArray

mapSyncResponseToRoomArray<T>(obj: Record<string, T>): WrappedRoom<T>[]
Type Parameters
- T extends IJoinedRoom | IInvitedRoom | ILeftRoom
Parameters
- obj: Record<string, T>
Returns WrappedRoom<T>[]
- Defined in src/sync.ts:1620

`Private` onMarkerStateEvent

onMarkerStateEvent(room: Room, markerEvent: MatrixEvent, setStateOptions?: IMarkerFoundOptions): void
When we see the marker state change in the room, we know there is some new historical messages imported by MSC2716 /batch_send somewhere in the room and we need to throw away the timeline to make sure the historical messages are shown when we paginate /messages again.
Parameters
- room: Room
  
  The room where the marker event was sent
- markerEvent: MatrixEvent
  
  The new marker event
- setStateOptions: IMarkerFoundOptions = {}
  
  When timelineWasEmpty is set as true, the given marker event will be ignored
Returns void
- Defined in src/sync.ts:264

`Private` onOnline

onOnline(): void
Event handler for the 'online' event This event is generally unreliable and precise behaviour varies between browsers, so we poll for connectivity too, but this might help us reconnect a little faster.

Returns void
- Defined in src/sync.ts:1827

`Private` onSyncError

onSyncError(err: MatrixError): Promise<boolean>
Parameters
- err: MatrixError
Returns Promise<boolean>
- Defined in src/sync.ts:1028

peek

peek(roomId: string): Promise<Room>
Peek into a room. This will result in the room in question being synced so it is accessible via getRooms(). Live updates for the room will be provided.

Returns
A promise which resolves once the room has been added to the store.
Parameters
- roomId: string
  
  The room ID to peek into.
Returns Promise<Room>
- Defined in src/sync.ts:402

`Private` peekPoll

peekPoll(peekRoom: Room, token?: string): void
Do a peek room poll.
Parameters
- peekRoom: Room
- Optional token: string
  
  from= token
Returns void
- Defined in src/sync.ts:481

`Private` pokeKeepAlive

pokeKeepAlive(connDidFail?: boolean): void
Make a dummy call to /_matrix/client/versions, to see if the HS is reachable.

On failure, schedules a call back to itself. On success, resolves this.connectionReturnedDefer.
Parameters
- connDidFail: boolean = false
  
  True if a connectivity failure has been detected. Optional.
Returns void
- Defined in src/sync.ts:1569

`Private` processEventsForNotifs

processEventsForNotifs(room: Room, timelineEventList: MatrixEvent[]): void
Takes a list of timelineEvents and adds and adds to notifEvents as appropriate. This must be called after the room the events belong to has been stored.
Parameters
- room: Room
- timelineEventList: MatrixEvent[]
  
  A list of timeline events. Lower index is earlier in time. Higher index is later.
Returns void
- Defined in src/sync.ts:1791

`Private` processSyncResponse

processSyncResponse(syncEventData: ISyncStateData, data: ISyncResponse): Promise<void>
Process data returned from a sync response and propagate it into the model objects
Parameters
- syncEventData: ISyncStateData
  
  Object containing sync tokens associated with this sync
- data: ISyncResponse
  
  The response from /sync
Returns Promise<void>
- Defined in src/sync.ts:1086

recoverFromSyncStartupError

recoverFromSyncStartupError(savedSyncPromise: undefined | Promise<void>, error: Error): Promise<void>
Parameters
- savedSyncPromise: undefined | Promise<void>
- error: Error
Returns Promise<void>
- Defined in src/sync.ts:575

`Private` resolveInvites

resolveInvites(room: Room): void
Parameters
- room: Room
Returns void
- Defined in src/sync.ts:1663

retryImmediately

retryImmediately(): boolean
Retry a backed off syncing request immediately. This should only be used when the user explicitly attempts to retry their lost connection.

Returns
True if this resulted in a request being retried.

Returns boolean
- Defined in src/sync.ts:824

`Private` shouldAbortSync

shouldAbortSync(error: MatrixError): boolean
Parameters
- error: MatrixError
Returns boolean
- Defined in src/sync.ts:605

`Private` startKeepAlives

startKeepAlives(delay?: number): Promise<boolean>
Starts polling the connectivity check endpoint

Returns
which resolves once the connection returns
Parameters
- Optional delay: number
  
  How long to delay until the first poll. defaults to a short, randomised interval (to prevent tight-looping if /versions succeeds but /sync etc. fail).
Returns Promise<boolean>
- Defined in src/sync.ts:1541

stop

stop(): void
Stops the sync object from syncing.

Returns void
- Defined in src/sync.ts:804

stopPeeking

stopPeeking(): void
Stop polling for updates in the peeked room. NOPs if there is no room being peeked.

Returns void
- Defined in src/sync.ts:473

sync

sync(): Promise<void>
Main entry point

Returns Promise<void>
- Defined in src/sync.ts:720

`Private` syncFromCache

syncFromCache(savedSync: ISavedSync): Promise<void>
Process a single set of cached sync data.
Parameters
- savedSync: ISavedSync
  
  a saved sync that was persisted by a store. This should have been acquired via client.store.getSavedSync().
Returns Promise<void>
- Defined in src/sync.ts:836

syncLeftRooms

syncLeftRooms(): Promise<Room[]>
Sync rooms the user has left.

Returns
Resolved when they've been added to the store.

Returns Promise<Room[]>
- Defined in src/sync.ts:326

`Private` updateSyncState

updateSyncState(newState: SyncState, data?: ISyncStateData): void
Sets the sync state and emits an event to say so
Parameters
- newState: SyncState
  
  The new state string
- Optional data: ISyncStateData
  
  Object of additional data to emit in the event
Returns void
- Defined in src/sync.ts:1814

`Private` wasLazyLoadingToggled

wasLazyLoadingToggled(lazyLoadMembers?: boolean): Promise<boolean>
Is the lazy loading option different than in previous session?

Returns
whether or not the option has changed compared to the previous session
Parameters
- lazyLoadMembers: boolean = false
  
  current options for lazy loading
Returns Promise<boolean>
- Defined in src/sync.ts:590

Class SyncApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: MatrixClient

Optional opts: IStoredClientOpts

Optional syncOpts: SyncApiOptions

Returns SyncApi

Properties

Private _peekRoom

Private Optional abortController

Private catchingUp

Private Readonly client

Private Optional connectionReturnedDefer

Private Optional currentSyncRequest

Private failedSyncCount

Private Optional keepAliveTimer

Private notifEvents

Private Readonly opts

Private running

Private Optional savedSyncPromise

Private storeIsInvalid

Private Readonly syncOpts

Private syncState

Private Optional syncStateData

Methods

Private buildDefaultFilter

Returns Filter

Private checkLazyLoadStatus

Returns Promise<void>

createRoom

Parameters

roomId: string

Returns Room

Private doSync

Parameters

syncOptions: ISyncOptions

Returns Promise<void>

Private doSyncRequest

Parameters

syncOptions: ISyncOptions

syncToken: null | string

Returns Promise<ISyncResponse>

Private getFilter

Returns Promise<{ filter?: Filter; filterId?: string; }>

Private getGuestFilter

Returns string

Private getPushRules

Returns Promise<void>

Private getSyncParams

Parameters

syncOptions: ISyncOptions

syncToken: null | string

Returns ISyncParams

getSyncState

See

Returns null | SyncState

getSyncStateData

Returns null | ISyncStateData

injectRoomEvents

Parameters

room: Room

stateEventList: MatrixEvent[]

Optional timelineEventList: MatrixEvent[]

fromCache: boolean = false

Returns Promise<void>

Private mapSyncEventsFormat

Parameters

obj: IEphemeral | ITimeline | IInviteState

Optional room: Room

decrypt: boolean = true

Returns MatrixEvent[]

Private mapSyncResponseToRoomArray

Type Parameters

T extends IJoinedRoom | IInvitedRoom | ILeftRoom

`Optional` opts: IStoredClientOpts

`Optional` syncOpts: SyncApiOptions

`Private` _peekRoom

`Private` `Optional` abortController

`Private` catchingUp

`Private` `Readonly` client

`Private` `Optional` connectionReturnedDefer

`Private` `Optional` currentSyncRequest

`Private` failedSyncCount

`Private` `Optional` keepAliveTimer

`Private` notifEvents

`Private` `Readonly` opts

`Private` running

`Private` `Optional` savedSyncPromise

`Private` storeIsInvalid

`Private` `Readonly` syncOpts

`Private` syncState

`Private` `Optional` syncStateData

`Private` buildDefaultFilter

`Private` checkLazyLoadStatus

`Private` doSync

`Private` doSyncRequest

`Private` getFilter

Returns Promise<{
filter?: Filter;
filterId?: string;
}>

`Private` getGuestFilter

`Private` getPushRules

`Private` getSyncParams

`Optional` timelineEventList: MatrixEvent[]

`Private` mapSyncEventsFormat

`Optional` room: Room

`Private` mapSyncResponseToRoomArray

`Private` onMarkerStateEvent

`Private` onOnline

`Private` onSyncError

`Private` peekPoll

`Optional` token: string

`Private` pokeKeepAlive

`Private` processEventsForNotifs

`Private` processSyncResponse

`Private` resolveInvites

`Private` shouldAbortSync

`Private` startKeepAlives

`Optional` delay: number

`Private` syncFromCache