Class StateLookup

Hierarchy

StateLookup

Index

Constructors

Methods

getState onEvent trackRoom untrackRoom

Constructors

constructor

new StateLookup(opts: StateLookupOpts): StateLookup
Construct a new state lookup entity.

This component stores state events for specific event types which can be queried at a later date. This component will perform network requests to fetch the current state for a given room ID. It relies on onEvent being called with later events in order to stay up-to-date. This should be connected to the onEvent handler on the Bridge.

Throws
if there is no client.
Parameters
- opts: StateLookupOpts
  
  Options for this constructor
Returns StateLookup

Methods

getState

getState(roomId: string, eventType: string, stateKey?: string): null | StateLookupEvent | StateLookupEvent[]
Get a stored state event.

Returns
Parameters
- roomId: string
- eventType: string
- Optional stateKey: string
  
  If specified, this function will return either the event or null. If not specified, this function will always return an array of events, which may be empty.
Returns null | StateLookupEvent | StateLookupEvent[]

onEvent

onEvent(event: StateLookupEvent): Promise<void>
Update any state dictionaries with this event. If there is nothing tracking this room, nothing is stored.
Parameters
- event: StateLookupEvent
  
  Raw matrix event
Returns Promise<void>

trackRoom

trackRoom(roomId: string): Promise<StateLookupRoom>
Track a given room. The client must have access to this room.

This will perform a room state query initially. Subsequent calls will do nothing, as it will rely on events being pushed to it via onEvent.

Returns
Resolves when the room is being tracked. Rejects if the room cannot be tracked.
Parameters
- roomId: string
  
  The room ID to start tracking. You can track multiple rooms by calling this function multiple times with different room IDs.
Returns Promise<StateLookupRoom>

untrackRoom

untrackRoom(roomId: string): void
Stop tracking a given room.

This will stop further tracking of state events in the given room and delete existing stored state for it.
Parameters
- roomId: string
  
  The room ID to stop tracking.
Returns void

Generated using TypeDoc