Abstract Optional options: EventEmitterOptionsPrivate receiptPrivate receiptsAbstract timelineAdd 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
Abstract addRest ...args: Parameters<SuperclassArguments[T]>Rest ...args: Parameters<Arguments[T]>Get the ID of the event that a given user has read up to, or null if we have received no read receipts 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
If 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
Abstract 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.
Determines if the given user has read a particular event ID with the known history of the room. This is not a definitive check as it relies only on what is available to the room 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.
Optional event: EventEmitterEvents | EventsGenerated 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.