Class SyncApi

Index

Constructors

Methods

createRoom getSyncState getSyncStateData injectRoomEvents peek recoverFromSyncStartupError retryImmediately setPresence stop stopPeeking sync syncLeftRooms

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.
- Optionalopts: IStoredClientOpts
  client config options
- OptionalsyncOpts: SyncApiOptions
  sync-specific options passed by the client
Returns SyncApi
- Defined in src/sync.ts:238

Methods

createRoom

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

getSyncState

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

Returns null | SyncState
See
MatrixClient#event:"sync"
- Defined in src/sync.ts:570

getSyncStateData

getSyncStateData(): null | SyncStateData
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 | SyncStateData
- Defined in src/sync.ts:581

injectRoomEvents

injectRoomEvents(
    room: Room,
    stateEventList: MatrixEvent[],
    stateAfterEventList: undefined,
    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.
- stateAfterEventList: undefined
  A list of state events. This is the state at the END of the timeline list if it is supplied.
- OptionaltimelineEventList: MatrixEvent[]
  A list of timeline events, including threaded. Lower index is earlier in time. Higher index is later.
- OptionalfromCache: boolean
  whether the sync response came from cache
  
  No more than one of stateEventList and stateAfterEventList must be supplied. If stateEventList is supplied, the events in timelineEventList are added to the state after stateEventList. If stateAfterEventList is supplied, the events in timelineEventList are not added to the state.
Returns Promise<void>
- Defined in src/sync.ts:1805
injectRoomEvents(
    room: Room,
    stateEventList: undefined,
    stateAfterEventList: MatrixEvent[],
    timelineEventList?: MatrixEvent[],
    fromCache?: boolean,
): Promise<void>
Injects events into a room's model.
Parameters
- room: Room
- stateEventList: undefined
  A list of state events. This is the state at the START of the timeline list if it is supplied.
- stateAfterEventList: MatrixEvent[]
  A list of state events. This is the state at the END of the timeline list if it is supplied.
- OptionaltimelineEventList: MatrixEvent[]
  A list of timeline events, including threaded. Lower index is earlier in time. Higher index is later.
- OptionalfromCache: boolean
  whether the sync response came from cache
  
  No more than one of stateEventList and stateAfterEventList must be supplied. If stateEventList is supplied, the events in timelineEventList are added to the state after stateEventList. If stateAfterEventList is supplied, the events in timelineEventList are not added to the state.
Returns Promise<void>
- Defined in src/sync.ts:1812

peek

peek(roomId: string, limit?: number): 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.
Parameters
- roomId: string
  The room ID to peek into.
- limit: number = 20
  The number of timeline events to initially retrieve.
Returns Promise<Room>
A promise which resolves once the room has been added to the store.
- Defined in src/sync.ts:407

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:585

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 boolean
True if this resulted in a request being retried.
- Defined in src/sync.ts:799

setPresence

setPresence(presence?: SetPresence): void
Specify the set_presence value to be used for subsequent calls to the Sync API.
Parameters
- Optionalpresence: SetPresence
  the presence to specify to set_presence of sync calls
Returns void
- Defined in src/sync.ts:1015

stop

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

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

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:483

sync

sync(): Promise<void>
Main entry point

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

syncLeftRooms

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

Returns Promise<Room[]>
Resolved when they've been added to the store.
- Defined in src/sync.ts:332

Class SyncApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SyncApi

Methods

createRoom

Parameters

Returns Room

getSyncState

Returns null | SyncState

See

getSyncStateData

Returns null | SyncStateData

injectRoomEvents

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

peek

Parameters

Returns Promise<Room>

recoverFromSyncStartupError

Parameters

Returns Promise<void>

retryImmediately

Returns boolean

setPresence

Parameters

Returns void

stop

Returns void

stopPeeking

Returns void

sync

Returns Promise<void>

syncLeftRooms

Returns Promise<Room[]>

Settings

On This Page