Private
_currentReadonly
clientReadonly
idPrivate
lastPrivate
lastPrivate
Readonly
pendingPrivate
pendingPrivate
reAn array of events to add to the timeline once the thread has been initialised with server suppport.
Private
replyReadonly
roomReadonly
timelineA reference to all the events ID at the bottom of the threads
Static
hasStatic
hasStatic
hasThe number of messages in the thread Only count rel_type=m.thread as we want to exclude annotations from that number
A getter for the last event of the thread. This might be a synthesized event, if so, it will not emit any events to listeners.
Add an event to the thread and updates the tail/root references if needed Will fire "Thread.update"
The event to add
whether the event is being added to the start (and not the end) of the timeline.
whether to emit the Update event if the thread was updated or not.
Private
addAdd a temporary local-echo receipt to the room to reflect in the client the fact that we've sent one.
The user ID if the receipt sender
The event that is to be acknowledged
The type of receipt
Rest
...args: Parameters<EventHandlerMap[T]>Rest
...args: Parameters<EventHandlerMap[T]>Private
fetchRest
...events: MatrixEvent[]Private
fetchFinds an event by ID in the current thread
This issue should also be addressed on synapse's side and is tracked as part of https://github.com/matrix-org/synapse/issues/14837
Retrieves the read receipt for the logged in user and checks if it matches the last event in the room and whether that event originated from the logged in user. Under those conditions we can consider the context as read. This is useful because we never send read receipts against our own events
the logged in user
Get the ID of the event that a given user has read up to within this thread, or null if we have received no read receipt (at all) from them.
ID of the latest event that the given user has read, or null.
The user ID to get read receipt event ID for
Optional
ignoreSynthesized: booleanIf true, return only receipts that have been sent by the server, not implicit ones generated by the JS SDK.
Gets the latest receipt for a given user in the room
the latest receipts of the chosen type for the chosen user
The id of the user for which we want the receipt
Whether to ignore synthesized receipts or not
Optional. The type of the receipt we want to get
Get a list of receipts for the given event.
A list of receipts with a userId, type and data keys or an empty list.
the event to get receipts for
Private
getGet a list of user IDs who have read up to the given event.
A list of user IDs.
the event to get read receipts for.
Determine if the given user has read a particular event.
It is invalid to call this method with an event that is not part of this thread.
This is not a definitive check as it only checks the events that have been loaded client-side at the time of execution.
True if the user has read the event, false otherwise.
The user ID to check the read state of.
The event ID to check if the user read.
Return last reply to the thread, if known.
Private
onPrivate
onPrivate
onPrivate
onPrivate
onPrivate
processProcesses the receipts that were caught during initial sync When clients become aware of a thread, they try to retrieve those read receipts and apply them to the current thread
A collection of the receipts cached from initial sync
Private
processOptional
event: EventEmitterEvents | EmittedEventsReset the live timeline of all timelineSets, and start new ones.
This is used when /sync returns a 'limited' timeline. 'Limited' means that there's a gap between the messages /sync returned, and the last known message in our timeline. In such a case, our live timeline isn't live anymore and has to be replaced by a new one. To make sure we can continue paginating our timelines correctly, we have to set new pagination tokens on the old and the new timeline.
Optional
backPaginationToken: null | stringtoken for back-paginating the new timeline
Optional
forwardPaginationToken: null | stringtoken for forward-paginating the old live timeline, if absent or null, all timelines are reset, removing old ones (including the previous live timeline which would otherwise be unable to paginate forwards without this token). Removing just the old live timeline whilst preserving previous ones is not supported.
Private
updatePrivate
updateStatic
setStatic
setStatic
setGenerated using TypeDoc
Typed Event Emitter class which can act as a Base Model for all our model and communication events. This makes it much easier for us to distinguish between events, as we now need to properly type this, so that our events are not stringly-based and prone to silly typos.