Class MemoryStore

constructor

• new MemoryStore(opts?: IOpts): MemoryStore

• Construct a new in-memory data store for the Matrix Client.

  Parameters

  • opts: IOpts = {}

    Config options

  Returns MemoryStore

accountData

clearOutOfBandMembers

• clearOutOfBandMembers(roomId: string): Promise<void>

• Parameters

  • roomId: string

  Returns Promise<void>

deleteAllData

• deleteAllData(): Promise<void>

• Delete all data from this store.

  Returns Promise<void>

  An immediately resolved promise.

destroy

• destroy(): Promise<void>

• Stop the store and perform any appropriate cleanup

  Returns Promise<void>

getAccountData

• getAccountData(eventType: string): 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

getClientOptions

• getClientOptions(): Promise<undefined | IStoredClientOpts>

• Returns Promise<undefined | IStoredClientOpts>

getFilter

• getFilter(userId: string, filterId: string): null | Filter

• Retrieve a filter.

  Parameters

  • userId: string
  • filterId: string

  Returns null | Filter

  A filter or null.

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.

getOldestToDeviceBatch

• getOldestToDeviceBatch(): Promise<null | IndexedToDeviceBatch>

• Fetches the oldest batch of to-device messages in the queue

  Returns Promise<null | IndexedToDeviceBatch>

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

getPendingEvents

• getPendingEvents(roomId: string): Promise<Partial<IEvent>[]>

• Parameters

  • roomId: string

  Returns Promise<Partial<IEvent>[]>

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.

getRooms

• getRooms(): Room[]

• Retrieve all known rooms.

  Returns Room[]

  A list of rooms, which may be empty.

getRoomSummaries

• getRoomSummaries(): RoomSummary[]

• Retrieve a summary of all the rooms.

  Returns RoomSummary[]

  A summary of each room.

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.

getSavedSyncToken

• getSavedSyncToken(): Promise<null | string>

• Returns Promise<null | string>

  If there is a saved sync, the nextBatch token for this sync, otherwise null.

getSyncToken

• getSyncToken(): null | string

• Retrieve the token to stream from.

  Returns null | string

  The token or null.

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.

getUsers

• getUsers(): User[]

• Retrieve all known users.

  Returns User[]

  A list of users, which may be empty.

isNewlyCreated

• isNewlyCreated(): Promise<boolean>

• Returns Promise<boolean>

  whether or not the database was newly created in this session.

removeRoom

• removeRoom(roomId: string): void

• Permanently delete a room.

  Parameters

  • roomId: string

  Returns void

removeToDeviceBatch

• removeToDeviceBatch(id: number): Promise<void>

• Removes a specific batch of to-device messages from the queue

  Parameters

  • id: number

  Returns Promise<void>

save

• save(force: boolean): 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>

saveToDeviceBatches

• saveToDeviceBatches(batches: ToDeviceBatchWithTxnId[]): Promise<void>

• Stores batches of outgoing to-device messages

  Parameters

  • batches: ToDeviceBatchWithTxnId[]

  Returns Promise<void>

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.

setFilterIdByName

• setFilterIdByName(filterName: string, filterId?: string): void

• Set a filter name to ID mapping.

  Parameters

  • filterName: string
  • OptionalfilterId: string

  Returns void

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

setPendingEvents

• setPendingEvents(roomId: string, events: Partial<IEvent>[]): Promise<void>

• Parameters

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

  Returns Promise<void>

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.

setSyncToken

• setSyncToken(token: string): void

• Set the token to stream from.

  Parameters

  • token: string

    The token to stream from.

  Returns void

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

startup

• startup(): Promise<void>

• Startup does nothing as this store doesn't require starting up.

  Returns Promise<void>

  An immediately resolved promise.

storeAccountDataEvents

• storeAccountDataEvents(events: MatrixEvent[]): 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

storeClientOptions

• storeClientOptions(options: IStoredClientOpts): Promise<void>

• Parameters

  • options: IStoredClientOpts

  Returns Promise<void>

storeEvents

• storeEvents(
      room: Room,
      events: MatrixEvent[],
      token: null | string,
      toStart: boolean,
  ): 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

storeFilter

• storeFilter(filter: Filter): void

• Store a filter.

  Parameters

  • filter: Filter

  Returns void

storeRoom

• storeRoom(room: Room): void

• Store the given room.

  Parameters

  • room: Room

    The room to be stored. All properties must be stored.

  Returns void

storeUser

• storeUser(user: User): void

• Store a User.

  Parameters

  • user: User

    The user to store.

  Returns void

wantsSave

• wantsSave(): boolean

• We never want to save becase we have nothing to save to.

  Returns boolean

  If the store wants to save