Interface IStore

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

Hierarchy

IStore

Implemented by

MemoryStore

Properties

`Readonly` accountData

accountData: Map<string, MatrixEvent>

`Optional` on

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

Type declaration

- (event: "closed" | EventEmitterEvents | "degraded", handler: ((...args: any[]) => void)): void
- Parameters
  - event: "closed" | EventEmitterEvents | "degraded"
  - handler: ((...args: any[]) => void)
    - (...args: any[]): void
      
      Parameters
      
      Rest ...args: any[]
      
      Returns void
  Returns void

Methods

clearOutOfBandMembers

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

deleteAllData

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

Returns
An immediately resolved promise.

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

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

getClientOptions

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

getFilter

getFilter(userId: string, filterId: string): null | Filter
Retrieve a filter.

Returns
A filter or null.
Parameters
- userId: string
- filterId: string
Returns null | Filter
- Defined in src/store/index.ts:135

getFilterIdByName

getFilterIdByName(filterName: string): null | string
Retrieve a filter ID with the given name.

Returns
The filter ID or null.
Parameters
- filterName: string
  
  The filter name.
Returns null | string
- Defined in src/store/index.ts:142

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

getOutOfBandMembers

getOutOfBandMembers(roomId: string): Promise<null | IStateEventWithRoomId[]>
Returns the out-of-band membership events for this room that were previously loaded.

Returns
the events, potentially an empty array if OOB loading didn't yield any new members

Returns
in case the members for this room haven't been stored yet
Parameters
- roomId: string
Returns Promise<null | IStateEventWithRoomId[]>
- Defined in src/store/index.ts:213

getPendingEvents

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

getRoom

getRoom(roomId: string): null | Room
Retrieve a room by its' room ID.

Returns
The room or null.
Parameters
- roomId: string
  
  The room ID.
Returns null | Room
- Defined in src/store/index.ts:70

getRoomSummaries

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

Returns
A summary of each room.

Returns RoomSummary[]
- Defined in src/store/index.ts:87

getRooms

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

Returns
A list of rooms, which may be empty.

Returns Room[]
- Defined in src/store/index.ts:76

getSavedSync

getSavedSync(): Promise<null | ISavedSync>
Returns
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.

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

getSavedSyncToken

getSavedSyncToken(): Promise<null | string>
Returns
If there is a saved sync, the nextBatch token for this sync, otherwise null.

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

getSyncToken

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

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

getUser

getUser(userId: string): null | User
Retrieve a User by its' user ID.

Returns
The user or null.
Parameters
- userId: string
  
  The user ID.
Returns null | User
- Defined in src/store/index.ts:100

getUsers

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

Returns
A list of users, which may be empty.

Returns User[]
- Defined in src/store/index.ts:106

isNewlyCreated

isNewlyCreated(): Promise<boolean>
Returns
whether or not the database was newly created in this session.

Returns Promise<boolean>
- Defined in src/store/index.ts:47

removeRoom

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

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

save

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

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

scrollback

scrollback(room: Room, limit: number): MatrixEvent[]
Retrieve scrollback for this room.

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

setFilterIdByName

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

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

Returns
when all members have been stored
Parameters
- roomId: string
- membershipEvents: IStateEventWithRoomId[]
  
  the membership events to store
Returns Promise<void>
- Defined in src/store/index.ts:222

setPendingEvents

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

setSyncData

setSyncData(syncData: ISyncResponse): Promise<void>
setSyncData does nothing as there is no backing data store.

Returns
An immediately resolved promise.
Parameters
- syncData: ISyncResponse
  
  The sync data
Returns Promise<void>
- Defined in src/store/index.ts:167

setSyncToken

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

startup

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

Returns
An immediately resolved promise.

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

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

storeClientOptions

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

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

storeFilter

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

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

storeUser

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

wantsSave

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

Returns
If the store wants to save

Returns boolean
- Defined in src/store/index.ts:174

Interface IStore

Hierarchy

Implemented by

Index

Properties

Methods

Properties

Readonly accountData

Optional on

Type declaration

Parameters

event: "closed" | EventEmitterEvents | "degraded"

handler: ((...args: any[]) => void)

Parameters

Rest ...args: any[]

Returns void

Returns void

Methods

clearOutOfBandMembers

Parameters

roomId: string

Returns Promise<void>

deleteAllData

Returns

Returns Promise<void>

getAccountData

Parameters

eventType: string

Returns undefined | MatrixEvent

getClientOptions

Returns Promise<undefined | IStartClientOpts>

getFilter

Returns

Parameters

userId: string

filterId: string

Returns null | Filter

getFilterIdByName

Returns

Parameters

filterName: string

Returns null | string

getOldestToDeviceBatch

Returns Promise<null | IndexedToDeviceBatch>

getOutOfBandMembers

Returns

Returns

Parameters

roomId: string

Returns Promise<null | IStateEventWithRoomId[]>

getPendingEvents

Parameters

roomId: string

Returns Promise<Partial<IEvent>[]>

getRoom

Returns

Parameters

roomId: string

Returns null | Room

getRoomSummaries

Returns

Returns RoomSummary[]

getRooms

Returns

Returns Room[]

getSavedSync

Returns

Returns Promise<null | ISavedSync>

getSavedSyncToken

Returns

Returns Promise<null | string>

getSyncToken

Returns null | string

getUser

Returns

Parameters

userId: string

Returns null | User

getUsers

Returns

`Readonly` accountData

`Optional` on

`Rest` ...args: any[]

`Optional` force: boolean

`Optional` filterId: string