matrix-js-sdk

    Class RoomStickyEventsStore

    Tracks sticky events on behalf of one room, and fires an event whenever a sticky event is updated or replaced.

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    Methods

    • Get an active sticky event that match the given type, sender, and stickyKey

      Parameters

      • sender: string

        The sender of the sticky event.

      • type: string

        The event type.

      • stickyKey: string

        The sticky key used by the event.

      Returns undefined | StickyMatrixEvent

      A matching active sticky event, or undefined.

    • Get active sticky events without a sticky key that match the given type and sender.

      Parameters

      • sender: string

        The sender of the sticky event.

      • type: string

        The event type.

      Returns StickyMatrixEvent[]

      An array of matching sticky events.

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

    MMNEPVFCICPMFPCPTTAAATR