Class SyncApi

Constructors

constructor

Methods

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

Constructors

constructor

Methods

createRoom

getSyncState

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

injectRoomEvents

  • injectRoomEvents(room, stateEventList, stateAfterEventList, timelineEventList?, fromCache?): 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>

  • injectRoomEvents(room, stateEventList, stateAfterEventList, timelineEventList?, fromCache?): Promise<void>

  • Parameters

    • room: Room
    • stateEventList: undefined
    • stateAfterEventList: MatrixEvent[]
    • OptionaltimelineEventList: MatrixEvent[]
    • OptionalfromCache: boolean

    Returns Promise<void>

peek

  • peek(roomId, limit?): 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.

recoverFromSyncStartupError

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.

setPresence

  • setPresence(presence?): 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

stop

  • stop(): void

  • Stops the sync object from syncing.

    Returns void

stopPeeking

  • stopPeeking(): void

  • Stop polling for updates in the peeked room. NOPs if there is no room being peeked.

    Returns void

sync

syncLeftRooms

Settings

Member Visibility

On This Page

Constructors
Methods