Interface IIndexedDBBackend

interface IIndexedDBBackend {
    clearDatabase(): Promise<void>;
    clearOutOfBandMembers(roomId: string): Promise<void>;
    connect(onClose?: (() => void)): Promise<void>;
    destroy(): Promise<void>;
    getClientOptions(): Promise<undefined | IStoredClientOpts>;
    getNextBatchToken(): Promise<string>;
    getOldestToDeviceBatch(): Promise<null | IndexedToDeviceBatch>;
    getOutOfBandMembers(roomId: string): Promise<null | IStateEventWithRoomId[]>;
    getSavedSync(): Promise<null | ISavedSync>;
    getUserPresenceEvents(): Promise<UserTuple[]>;
    isNewlyCreated(): Promise<boolean>;
    removeToDeviceBatch(id: number): Promise<void>;
    saveToDeviceBatches(batches: ToDeviceBatchWithTxnId[]): Promise<void>;
    setOutOfBandMembers(roomId: string, membershipEvents: IStateEventWithRoomId[]): Promise<void>;
    setSyncData(syncData: ISyncResponse): Promise<void>;
    storeClientOptions(options: IStoredClientOpts): Promise<void>;
    syncToDatabase(userTuples: UserTuple[]): Promise<void>;
}

Index

Methods

clearDatabase clearOutOfBandMembers connect destroy getClientOptions getNextBatchToken getOldestToDeviceBatch getOutOfBandMembers getSavedSync getUserPresenceEvents isNewlyCreated removeToDeviceBatch saveToDeviceBatches setOutOfBandMembers setSyncData storeClientOptions syncToDatabase

Methods

clearDatabase

clearDatabase(): Promise<void>
Returns Promise<void>
- Defined in src/store/indexeddb-backend.ts:28

clearOutOfBandMembers

clearOutOfBandMembers(roomId): Promise<void>
Parameters
- roomId: string
Returns Promise<void>
- Defined in src/store/indexeddb-backend.ts:31

connect

connect(onClose?): Promise<void>
Parameters
- OptionalonClose: (() => void)
  - - (): void
    - Returns void
Returns Promise<void>
- Defined in src/store/indexeddb-backend.ts:22

destroy

destroy(): Promise<void>
Returns Promise<void>
- Defined in src/store/indexeddb-backend.ts:38

getClientOptions

getClientOptions(): Promise<undefined | IStoredClientOpts>
Returns Promise<undefined | IStoredClientOpts>
- Defined in src/store/indexeddb-backend.ts:33

getNextBatchToken

getNextBatchToken(): Promise<string>
Returns Promise<string>
- Defined in src/store/indexeddb-backend.ts:27

getOldestToDeviceBatch

getOldestToDeviceBatch(): Promise<null | IndexedToDeviceBatch>
Returns Promise<null | IndexedToDeviceBatch>
- Defined in src/store/indexeddb-backend.ts:36

getOutOfBandMembers

getOutOfBandMembers(roomId): Promise<null | IStateEventWithRoomId[]>
Parameters
- roomId: string
Returns Promise<null | IStateEventWithRoomId[]>
- Defined in src/store/indexeddb-backend.ts:29

getSavedSync

getSavedSync(): Promise<null | ISavedSync>
Returns Promise<null | ISavedSync>
- Defined in src/store/indexeddb-backend.ts:26

getUserPresenceEvents

getUserPresenceEvents(): Promise<UserTuple[]>
Returns Promise<UserTuple[]>
- Defined in src/store/indexeddb-backend.ts:32

isNewlyCreated

isNewlyCreated(): Promise<boolean>
Returns Promise<boolean>
- Defined in src/store/indexeddb-backend.ts:24

removeToDeviceBatch

removeToDeviceBatch(id): Promise<void>
Parameters
- id: number
Returns Promise<void>
- Defined in src/store/indexeddb-backend.ts:37

saveToDeviceBatches

saveToDeviceBatches(batches): Promise<void>
Parameters
- batches: ToDeviceBatchWithTxnId[]
Returns Promise<void>
- Defined in src/store/indexeddb-backend.ts:35

setOutOfBandMembers

setOutOfBandMembers(roomId, membershipEvents): Promise<void>
Parameters
- roomId: string
- membershipEvents: IStateEventWithRoomId[]
Returns Promise<void>
- Defined in src/store/indexeddb-backend.ts:30

setSyncData

setSyncData(syncData): Promise<void>
Parameters
- syncData: ISyncResponse
Returns Promise<void>
- Defined in src/store/indexeddb-backend.ts:25

storeClientOptions

storeClientOptions(options): Promise<void>
Parameters
- options: IStoredClientOpts
Returns Promise<void>
- Defined in src/store/indexeddb-backend.ts:34

syncToDatabase

syncToDatabase(userTuples): Promise<void>
Parameters
- userTuples: UserTuple[]
Returns Promise<void>
- Defined in src/store/indexeddb-backend.ts:23

Interface IIndexedDBBackend

Index

Methods

Methods

clearDatabase

Returns Promise<void>

clearOutOfBandMembers

Parameters

Returns Promise<void>

connect

Parameters

Returns void

Returns Promise<void>

destroy

Returns Promise<void>

getClientOptions

Returns Promise<undefined | IStoredClientOpts>

getNextBatchToken

Returns Promise<string>

getOldestToDeviceBatch

Returns Promise<null | IndexedToDeviceBatch>

getOutOfBandMembers

Parameters

Returns Promise<null | IStateEventWithRoomId[]>

getSavedSync

Returns Promise<null | ISavedSync>

getUserPresenceEvents

Returns Promise<UserTuple[]>

isNewlyCreated

Returns Promise<boolean>

removeToDeviceBatch

Parameters

Returns Promise<void>

saveToDeviceBatches

Parameters

Returns Promise<void>

setOutOfBandMembers

Parameters

Returns Promise<void>

setSyncData

Parameters

Returns Promise<void>

storeClientOptions

Parameters

Returns Promise<void>

syncToDatabase

Parameters

Returns Promise<void>

Settings

On This Page