Class MemoryStore

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

Hierarchy (view full)

MemoryStore
- IndexedDBStore

Implements

IStore

Constructors

constructor

new MemoryStore(opts?): MemoryStore
Construct a new in-memory data store for the Matrix Client.
Parameters
- opts: IOpts = {}
  Config options
Returns MemoryStore
- Defined in src/store/memory.ts:72

Properties

accountData

accountData: Map<string, MatrixEvent> = ...

`Private` `Optional` clientOptions

clientOptions?: IStoredClientOpts

`Protected` `Optional` createUser

createUser?: UserCreator

`Private` filters

filters: MapWithDefault<string, Map<string, Filter>> = ...

`Protected` `Optional` `Readonly` localStorage

localStorage?: Storage

`Private` nextToDeviceBatchId

nextToDeviceBatchId: number = 0

`Private` oobMembers

oobMembers: Map<string, IStateEventWithRoomId[]> = ...

`Private` pendingEvents

pendingEvents: {
[roomId: string]: Partial<IEvent>[];
} = {}

Type declaration

[roomId: string]: Partial<IEvent>[]

`Private` pendingToDeviceBatches

pendingToDeviceBatches: IndexedToDeviceBatch[] = []

`Private` rooms

rooms: Record<string, Room> = {}

`Private` syncToken

syncToken: null | string = null

`Private` users

users: Record<string, User> = {}

Methods

clearOutOfBandMembers

clearOutOfBandMembers(roomId): Promise<void>
Parameters
- roomId: string
Returns Promise<void>
Implementation of IStore.clearOutOfBandMembers
- Defined in src/store/memory.ts:400

deleteAllData

deleteAllData(): Promise<void>
Delete all data from this store.

Returns Promise<void>
An immediately resolved promise.
Implementation of IStore.deleteAllData
- Defined in src/store/memory.ts:365

destroy

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

Returns Promise<void>
Implementation of IStore.destroy
- Defined in src/store/memory.ts:444

getAccountData

getAccountData(eventType): undefined | MatrixEvent
Get account data event by event type
Parameters
- eventType: string
  The event type being queried
Returns undefined | MatrixEvent
the user account_data event of given type, if any
Implementation of IStore.getAccountData
- Defined in src/store/memory.ts:304

getClientOptions

getClientOptions(): Promise<undefined | IStoredClientOpts>
Returns Promise<undefined | IStoredClientOpts>
Implementation of IStore.getClientOptions
- Defined in src/store/memory.ts:405

getFilter

getFilter(userId, filterId): null | Filter
Retrieve a filter.
Parameters
- userId: string
- filterId: string
Returns null | Filter
A filter or null.
Implementation of IStore.getFilter
- Defined in src/store/memory.ts:236

getFilterIdByName

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

getOldestToDeviceBatch

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

Returns Promise<null | IndexedToDeviceBatch>
Implementation of IStore.getOldestToDeviceBatch
- Defined in src/store/memory.ts:434

getOutOfBandMembers

getOutOfBandMembers(roomId): 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
Implementation of IStore.getOutOfBandMembers
- Defined in src/store/memory.ts:384

getPendingEvents

getPendingEvents(roomId): Promise<Partial<IEvent>[]>
Parameters
- roomId: string
Returns Promise<Partial<IEvent>[]>
Implementation of IStore.getPendingEvents
- Defined in src/store/memory.ts:414

getRoom

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

getRoomSummaries

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

Returns RoomSummary[]
A summary of each room.
Implementation of IStore.getRoomSummaries
- Defined in src/store/memory.ts:171

getRooms

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

Returns Room[]
A list of rooms, which may be empty.
Implementation of IStore.getRooms
- Defined in src/store/memory.ts:153

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.
Implementation of IStore.getSavedSync
- Defined in src/store/memory.ts:349

getSavedSyncToken

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

getSyncToken

getSyncToken(): null | string
Retrieve the token to stream from.

Returns null | string
The token or null.
Implementation of IStore.getSyncToken
- Defined in src/store/memory.ts:80

getUser

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

getUsers

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

Returns User[]
A list of users, which may be empty.
Implementation of IStore.getUsers
- Defined in src/store/memory.ts:198

isNewlyCreated

isNewlyCreated(): Promise<boolean>
Returns Promise<boolean>
whether or not the database was newly created in this session.
Implementation of IStore.isNewlyCreated
- Defined in src/store/memory.ts:85

`Private` onRoomMember

onRoomMember(event, state, member): void
Called when a room member in a room being tracked by this store has been updated.
Parameters
- event: null | MatrixEvent
- state: RoomState
- member: RoomMember
Returns void
- Defined in src/store/memory.ts:120

removeRoom

removeRoom(roomId): void
Permanently delete a room.
Parameters
- roomId: string
Returns void
Implementation of IStore.removeRoom
- Defined in src/store/memory.ts:160

removeToDeviceBatch

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

save

save(force): Promise<void>
Save does nothing as there is no backing data store.
Parameters
- force: boolean
  True to force a save (but the memory store still can't save anything)
Returns Promise<void>
Implementation of IStore.save
- Defined in src/store/memory.ts:332

saveToDeviceBatches

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

scrollback

scrollback(room, limit): 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.
Implementation of IStore.scrollback
- Defined in src/store/memory.ts:209

setFilterIdByName

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

setOutOfBandMembers

setOutOfBandMembers(roomId, membershipEvents): 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
Implementation of IStore.setOutOfBandMembers
- Defined in src/store/memory.ts:395

setPendingEvents

setPendingEvents(roomId, events): Promise<void>
Parameters
- roomId: string
- events: Partial<IEvent>[]
Returns Promise<void>
Implementation of IStore.setPendingEvents
- Defined in src/store/memory.ts:418

setSyncData

setSyncData(syncData): 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.
Implementation of IStore.setSyncData
- Defined in src/store/memory.ts:314

setSyncToken

setSyncToken(token): void
Set the token to stream from.
Parameters
- token: string
  The token to stream from.
Returns void
Implementation of IStore.setSyncToken
- Defined in src/store/memory.ts:93

setUserCreator

setUserCreator(creator): 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
Implementation of IStore.setUserCreator
- Defined in src/store/memory.ts:112

startup

startup(): Promise<void>
Startup does nothing as this store doesn't require starting up.

Returns Promise<void>
An immediately resolved promise.
Implementation of IStore.startup
- Defined in src/store/memory.ts:340

storeAccountDataEvents

storeAccountDataEvents(events): void
Store user-scoped account data events. N.B. that account data only allows a single event per type, so multiple events with the same type will replace each other.
Parameters
- events: MatrixEvent[]
  The events to store.
Returns void
Implementation of IStore.storeAccountDataEvents
- Defined in src/store/memory.ts:287

storeClientOptions

storeClientOptions(options): Promise<void>
Parameters
- options: IStoredClientOpts
Returns Promise<void>
Implementation of IStore.storeClientOptions
- Defined in src/store/memory.ts:409

storeEvents

storeEvents(room, events, token, toStart): void
Store events for a room. The events have already been added to the timeline
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
Implementation of IStore.storeEvents
- Defined in src/store/memory.ts:220

storeFilter

storeFilter(filter): void
Store a filter.
Parameters
- filter: Filter
Returns void
Implementation of IStore.storeFilter
- Defined in src/store/memory.ts:227

storeRoom

storeRoom(room): void
Store the given room.
Parameters
- room: Room
  The room to be stored. All properties must be stored.
Returns void
Implementation of IStore.storeRoom
- Defined in src/store/memory.ts:101

storeUser

storeUser(user): void
Store a User.
Parameters
- user: User
  The user to store.
Returns void
Implementation of IStore.storeUser
- Defined in src/store/memory.ts:181

wantsSave

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

Returns boolean
If the store wants to save
Implementation of IStore.wantsSave
- Defined in src/store/memory.ts:323

Class MemoryStore

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MemoryStore

Properties

accountData

Private Optional clientOptions

Protected Optional createUser

Private filters

Protected Optional Readonly localStorage

Private nextToDeviceBatchId

Private oobMembers

Private pendingEvents

Type declaration

[roomId: string]: Partial<IEvent>[]

Private pendingToDeviceBatches

Private rooms

Private syncToken

Private users

Methods

clearOutOfBandMembers

Parameters

Returns Promise<void>

deleteAllData

Returns Promise<void>

destroy

Returns Promise<void>

getAccountData

Parameters

Returns undefined | MatrixEvent

getClientOptions

Returns Promise<undefined | IStoredClientOpts>

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

getRoomSummaries

Returns RoomSummary[]

getRooms

Returns Room[]

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>

Private onRoomMember

Parameters

Returns void

removeRoom

Parameters

Returns void

removeToDeviceBatch

`Private` `Optional` clientOptions

`Protected` `Optional` createUser

`Private` filters

`Protected` `Optional` `Readonly` localStorage

`Private` nextToDeviceBatchId

`Private` oobMembers

`Private` pendingEvents

`Private` pendingToDeviceBatches

`Private` rooms

`Private` syncToken

`Private` users

`Private` onRoomMember