Class ReadReceipt<Events, Arguments, SuperclassArguments>Abstract

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.

Type parameters:

  • Events - List of all events emitted by this TypedEventEmitter. Normally an enum type.
  • Arguments - A ListenerMap type providing mappings from event names to listener types.
  • SuperclassArguments - TODO: not really sure. Alternative listener mappings, I think? But only honoured for .emit?

Type Parameters

Hierarchy (view full)

Constructors

Properties

receiptCacheByEventId: ReceiptCache = ...
receipts: MapWithDefault<string, Map<string, [realReceipt: null | WrappedReceipt, syntheticReceipt: null | WrappedReceipt]>> = ...

Accessors

Methods

  • Add a temporary local-echo receipt to the room to reflect in the client the fact that we've sent one.

    Parameters

    • userId: string

      The user ID if the receipt sender

    • e: MatrixEvent

      The event that is to be acknowledged

    • receiptType: ReceiptType

      The type of receipt

    • unthreaded: boolean = false

      the receipt is unthreaded

    Returns void

  • Look in this room/thread's timeline to find an event. If this is a room, we look in all threads, but if this is a thread, we look only inside this thread.

    Parameters

    • eventId: string

    Returns undefined | MatrixEvent

  • 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

    Parameters

    • userId: string

      the logged in user

    Returns void

  • Get the ID of the event that a given user has read up to, or null if:

    • we have received no read receipts for them, or
    • the receipt we have points at an event we don't have, or
    • the thread ID in the receipt does not match the thread root of the referenced event.

    (The event might not exist if it is not loaded, and the thread ID might not match if the event has moved thread because it was redacted.)

    Parameters

    • userId: string

      The user ID to get read receipt event ID for

    • ignoreSynthesized: boolean = false

      If true, return only receipts that have been sent by the server, not implicit ones generated by the JS SDK.

    Returns null | string

    ID of the latest existing event that the given user has read, or null.

  • Returns the most recent unthreaded receipt for a given user

    Parameters

    • userId: string

      the MxID of the User

    Returns undefined | Receipt

    an unthreaded Receipt. Can be undefined if receipts have been disabled or a user chooses to use private read receipts (or we have simply not received a receipt from this user yet).

    Deprecated

    use hasUserReadEvent or getEventReadUpTo instead

  • Gets the latest receipt for a given user in the room

    Parameters

    • userId: string

      The id of the user for which we want the receipt

    • ignoreSynthesized: boolean = false

      Whether to ignore synthesized receipts or not

    • receiptType: ReceiptType = ReceiptType.Read

      Optional. The type of the receipt we want to get

    Returns null | WrappedReceipt

    the latest receipts of the chosen type for the chosen user

  • Get a list of user IDs who have read up to the given event.

    Parameters

    Returns string[]

    A list of user IDs.

  • 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.

    Parameters

    • userId: string

      The user ID to check the read state of.

    • eventId: string

      The event ID to check if the user read.

    Returns boolean

    True if the user has read the event, false otherwise.

  • Adds the listener function to the end of the listeners array for the event named event.

    No checks are made to see if the listener has already been added. Multiple calls passing the same combination of event and listener will result in the listener being added, and called, multiple times.

    By default, event listeners are invoked in the order they are added. The TypedEventEmitter#prependListener method can be used as an alternative to add the event listener to the beginning of the listeners array.

    Type Parameters

    • T extends string

    Parameters

    Returns this

    a reference to the EventEmitter, so that calls can be chained.

  • Adds a one-time listener function for the event named event. The next time event is triggered, this listener is removed and then invoked.

    Returns a reference to the EventEmitter, so that calls can be chained.

    By default, event listeners are invoked in the order they are added. The TypedEventEmitter#prependOnceListener method can be used as an alternative to add the event listener to the beginning of the listeners array.

    Type Parameters

    • T extends string

    Parameters

    Returns this

    a reference to the EventEmitter, so that calls can be chained.

  • Adds the listener function to the beginning of the listeners array for the event named event.

    No checks are made to see if the listener has already been added. Multiple calls passing the same combination of event and listener will result in the listener being added, and called, multiple times.

    Type Parameters

    • T extends string

    Parameters

    Returns this

    a reference to the EventEmitter, so that calls can be chained.

  • Adds a one-timelistener function for the event named event to the beginning of the listeners array. The next time event is triggered, this listener is removed, and then invoked.

    Type Parameters

    • T extends string

    Parameters

    Returns this

    a reference to the EventEmitter, so that calls can be chained.

  • Returns true if the event pointed at by this receipt exists, and its threadRootId is consistent with the thread information in the receipt.

    Parameters

    Returns boolean

  • Removes all listeners, or those of the specified event.

    It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

    Parameters

    Returns this

    a reference to the EventEmitter, so that calls can be chained.

Generated using TypeDoc