Interface IStore

A store for most of the data js-sdk needs to store, apart from crypto data

interface IStore {
    accountData: Map<string, MatrixEvent>;
    on?: (
        event: "closed" | EventEmitterEvents | "degraded",
        handler: (...args: any[]) => void,
    ) => void;
    clearOutOfBandMembers(roomId: string): Promise<void>;
    deleteAllData(): Promise<void>;
    destroy(): Promise<void>;
    getAccountData(eventType: string): undefined | MatrixEvent;
    getClientOptions(): Promise<undefined | IStartClientOpts>;
    getFilter(userId: string, filterId: string): null | Filter;
    getFilterIdByName(filterName: string): null | string;
    getOldestToDeviceBatch(): Promise<null | IndexedToDeviceBatch>;
    getOutOfBandMembers(
        roomId: string,
    ): Promise<null | IStateEventWithRoomId[]>;
    getPendingEvents(roomId: string): Promise<Partial<IEvent>[]>;
    getRoom(roomId: string): null | Room;
    getRooms(): Room[];
    getRoomSummaries(): RoomSummary[];
    getSavedSync(): Promise<null | ISavedSync>;
    getSavedSyncToken(): Promise<null | string>;
    getSyncToken(): null | string;
    getUser(userId: string): null | User;
    getUsers(): User[];
    isNewlyCreated(): Promise<boolean>;
    removeRoom(roomId: string): void;
    removeToDeviceBatch(id: number): Promise<void>;
    save(force?: boolean): Promise<void>;
    saveToDeviceBatches(batch: ToDeviceBatchWithTxnId[]): Promise<void>;
    scrollback(room: Room, limit: number): MatrixEvent[];
    setFilterIdByName(filterName: string, filterId?: string): void;
    setOutOfBandMembers(
        roomId: string,
        membershipEvents: IStateEventWithRoomId[],
    ): Promise<void>;
    setPendingEvents(roomId: string, events: Partial<IEvent>[]): Promise<void>;
    setSyncData(syncData: ISyncResponse): Promise<void>;
    setSyncToken(token: string): void;
    setUserCreator(creator: UserCreator): void;
    startup(): Promise<void>;
    storeAccountDataEvents(events: MatrixEvent[]): void;
    storeClientOptions(options: IStartClientOpts): Promise<void>;
    storeEvents(
        room: Room,
        events: MatrixEvent[],
        token: null | string,
        toStart: boolean,
    ): void;
    storeFilter(filter: Filter): void;
    storeRoom(room: Room): void;
    storeUser(user: User): void;
    wantsSave(): boolean;
}

Implemented by

MemoryStore

Properties

`Readonly`accountData

accountData: Map<string, MatrixEvent>

`Optional`on

on?: (
event: "closed" | EventEmitterEvents | "degraded",
handler: (...args: any[]) => void,
) => void

Methods

clearOutOfBandMembers

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

deleteAllData

deleteAllData(): Promise<void>
Delete all data from this store. Does nothing since this store doesn't store anything.

Returns Promise<void>
An immediately resolved promise.
- Defined in src/store/index.ts:213

destroy

destroy(): Promise<void>
Stop the store and perform any appropriate cleanup

Returns Promise<void>
- Defined in src/store/index.ts:260

getAccountData

getAccountData(eventType: string): undefined | MatrixEvent
Get account data event by event type
Parameters
- eventType: string
  The event type being queried
Returns undefined | MatrixEvent
- Defined in src/store/index.ts:167

getClientOptions

getClientOptions(): Promise<undefined | IStartClientOpts>
Returns Promise<undefined | IStartClientOpts>
- Defined in src/store/index.ts:234

getFilter

getFilter(userId: string, filterId: string): null | Filter
Retrieve a filter.
Parameters
- userId: string
- filterId: string
Returns null | Filter
A filter or null.
- Defined in src/store/index.ts:143

getFilterIdByName

getFilterIdByName(filterName: string): null | string
Retrieve a filter ID with the given name.
Parameters
- filterName: string
  The filter name.
Returns null | string
The filter ID or null.
- Defined in src/store/index.ts:150

getOldestToDeviceBatch

getOldestToDeviceBatch(): Promise<null | IndexedToDeviceBatch>
Fetches the oldest batch of to-device messages in the queue

Returns Promise<null | IndexedToDeviceBatch>
- Defined in src/store/index.ts:250

getOutOfBandMembers

getOutOfBandMembers(roomId: string): Promise<null | IStateEventWithRoomId[]>
Returns the out-of-band membership events for this room that were previously loaded.
Parameters
- roomId: string
Returns Promise<null | IStateEventWithRoomId[]>
the events, potentially an empty array if OOB loading didn't yield any new members
- Defined in src/store/index.ts:221

getPendingEvents

getPendingEvents(roomId: string): Promise<Partial<IEvent>[]>
Parameters
- roomId: string
Returns Promise<Partial<IEvent>[]>
- Defined in src/store/index.ts:238

getRoom

getRoom(roomId: string): null | Room
Retrieve a room by its' room ID.
Parameters
- roomId: string
  The room ID.
Returns null | Room
The room or null.
- Defined in src/store/index.ts:78

getRooms

getRooms(): Room[]
Retrieve all known rooms.

Returns Room[]
A list of rooms, which may be empty.
- Defined in src/store/index.ts:84

getRoomSummaries

getRoomSummaries(): RoomSummary[]
Retrieve a summary of all the rooms.

Returns RoomSummary[]
A summary of each room.
- Defined in src/store/index.ts:95

getSavedSync

getSavedSync(): Promise<null | ISavedSync>
Returns Promise<null | ISavedSync>
Promise which resolves with a sync response to restore the client state to where it was at the last save, or null if there is no saved sync data.
- Defined in src/store/index.ts:200

getSavedSyncToken

getSavedSyncToken(): Promise<null | string>
Returns Promise<null | string>
If there is a saved sync, the nextBatch token for this sync, otherwise null.
- Defined in src/store/index.ts:206

getSyncToken

getSyncToken(): null | string
Get the sync token.

Returns null | string
- Defined in src/store/index.ts:54

getUser

getUser(userId: string): null | User
Retrieve a User by its' user ID.
Parameters
- userId: string
  The user ID.
Returns null | User
The user or null.
- Defined in src/store/index.ts:108

getUsers

getUsers(): User[]
Retrieve all known users.

Returns User[]
A list of users, which may be empty.
- Defined in src/store/index.ts:114

isNewlyCreated

isNewlyCreated(): Promise<boolean>
Returns Promise<boolean>
whether or not the database was newly created in this session.
- Defined in src/store/index.ts:49

removeRoom

removeRoom(roomId: string): void
Permanently delete a room.
Parameters
- roomId: string
Returns void
- Defined in src/store/index.ts:89

removeToDeviceBatch

removeToDeviceBatch(id: number): Promise<void>
Removes a specific batch of to-device messages from the queue
Parameters
- id: number
Returns Promise<void>
- Defined in src/store/index.ts:255

save

save(force?: boolean): Promise<void>
Save does nothing as there is no backing data store.
Parameters
- Optionalforce: boolean
Returns Promise<void>
- Defined in src/store/index.ts:187

saveToDeviceBatches

saveToDeviceBatches(batch: ToDeviceBatchWithTxnId[]): Promise<void>
Stores batches of outgoing to-device messages
Parameters
- batch: ToDeviceBatchWithTxnId[]
Returns Promise<void>
- Defined in src/store/index.ts:245

scrollback

scrollback(room: Room, limit: number): MatrixEvent[]
Retrieve scrollback for this room.
Parameters
- room: Room
  The matrix room
- limit: number
  The max number of old events to retrieve.
Returns MatrixEvent[]
An array of objects which will be at most 'limit' length and at least 0. The objects are the raw event JSON.
- Defined in src/store/index.ts:123

setFilterIdByName

setFilterIdByName(filterName: string, filterId?: string): void
Set a filter name to ID mapping.
Parameters
- filterName: string
- OptionalfilterId: string
Returns void
- Defined in src/store/index.ts:155

setOutOfBandMembers

setOutOfBandMembers(
roomId: string,
membershipEvents: IStateEventWithRoomId[],
): Promise<void>
Stores the out-of-band membership events for this room. Note that it still makes sense to store an empty array as the OOB status for the room is marked as fetched, and getOutOfBandMembers will return an empty array instead of null
Parameters
- roomId: string
- membershipEvents: IStateEventWithRoomId[]
  the membership events to store
Returns Promise<void>
when all members have been stored
- Defined in src/store/index.ts:230

setPendingEvents

setPendingEvents(roomId: string, events: Partial<IEvent>[]): Promise<void>
Parameters
- roomId: string
- events: Partial<IEvent>[]
Returns Promise<void>
- Defined in src/store/index.ts:240

setSyncData

setSyncData(syncData: ISyncResponse): Promise<void>
setSyncData does nothing as there is no backing data store.
Parameters
- syncData: ISyncResponse
  The sync data
Returns Promise<void>
An immediately resolved promise.
- Defined in src/store/index.ts:175

setSyncToken

setSyncToken(token: string): void
Set the sync token.
Parameters
- token: string
Returns void
- Defined in src/store/index.ts:59

setUserCreator

setUserCreator(creator: UserCreator): void
Set the user creator which is used for creating User objects
Parameters
- creator: UserCreator
  A callback that accepts an user-id and returns an User object
Returns void
- Defined in src/store/index.ts:71

startup

startup(): Promise<void>
Startup does nothing.

Returns Promise<void>
An immediately resolved promise.
- Defined in src/store/index.ts:193

storeAccountDataEvents

storeAccountDataEvents(events: MatrixEvent[]): void
Store user-scoped account data events
Parameters
- events: MatrixEvent[]
  The events to store.
Returns void
- Defined in src/store/index.ts:161

storeClientOptions

storeClientOptions(options: IStartClientOpts): Promise<void>
Parameters
- options: IStartClientOpts
Returns Promise<void>
- Defined in src/store/index.ts:236

storeEvents

storeEvents(
    room: Room,
    events: MatrixEvent[],
    token: null | string,
    toStart: boolean,
): void
Store events for a room.
Parameters
- room: Room
  The room to store events for.
- events: MatrixEvent[]
  The events to store.
- token: null | string
  The token associated with these events.
- toStart: boolean
  True if these are paginated results.
Returns void
- Defined in src/store/index.ts:132

storeFilter

storeFilter(filter: Filter): void
Store a filter.
Parameters
- filter: Filter
Returns void
- Defined in src/store/index.ts:137

storeRoom

storeRoom(room: Room): void
Store the given room.
Parameters
- room: Room
  The room to be stored. All properties must be stored.
Returns void
- Defined in src/store/index.ts:65

storeUser

storeUser(user: User): void
Store a User.
Parameters
- user: User
  The user to store.
Returns void
- Defined in src/store/index.ts:101

wantsSave

wantsSave(): boolean
We never want to save because we have nothing to save to.

Returns boolean
If the store wants to save
- Defined in src/store/index.ts:182

Interface IStore

Implemented by

Index

Properties

Methods

Properties

ReadonlyaccountData

Optionalon

Methods

clearOutOfBandMembers

Parameters

Returns Promise<void>

deleteAllData

Returns Promise<void>

destroy

Returns Promise<void>

getAccountData

Parameters

Returns undefined | MatrixEvent

getClientOptions

Returns Promise<undefined | IStartClientOpts>

getFilter

Parameters

Returns null | Filter

getFilterIdByName

Parameters

Returns null | string

getOldestToDeviceBatch

Returns Promise<null | IndexedToDeviceBatch>

getOutOfBandMembers

Parameters

Returns Promise<null | IStateEventWithRoomId[]>

getPendingEvents

Parameters

Returns Promise<Partial<IEvent>[]>

getRoom

Parameters

Returns null | Room

getRooms

Returns Room[]

getRoomSummaries

Returns RoomSummary[]

getSavedSync

Returns Promise<null | ISavedSync>

getSavedSyncToken

Returns Promise<null | string>

getSyncToken

Returns null | string

getUser

Parameters

Returns null | User

getUsers

Returns User[]

isNewlyCreated

Returns Promise<boolean>

removeRoom

Parameters

Returns void

removeToDeviceBatch

Parameters

Returns Promise<void>

save

Parameters

Returns Promise<void>

saveToDeviceBatches

Parameters

Returns Promise<void>

scrollback

Parameters

Returns MatrixEvent[]

setFilterIdByName

Parameters

Returns void

setOutOfBandMembers

Parameters

Returns Promise<void>

setPendingEvents

Parameters

Returns Promise<void>

setSyncData

`Readonly`accountData

`Optional`on