Type Alias RoomStickyEventsMap

type RoomStickyEventsMap = {
    "RoomStickyEvents.Update": (
        added: StickyMatrixEvent[],
        updated: { current: StickyMatrixEvent; previous: StickyMatrixEvent }[],
        removed: StickyMatrixEvent[],
    ) => void;
}

Index

Properties

RoomStickyEvents.Update

Properties

RoomStickyEvents.Update

"RoomStickyEvents.Update": (
    added: StickyMatrixEvent[],
    updated: { current: StickyMatrixEvent; previous: StickyMatrixEvent }[],
    removed: StickyMatrixEvent[],
) => void

Fires when any sticky event changes happen in a room.

Type Declaration

- (
      added: StickyMatrixEvent[],
      updated: { current: StickyMatrixEvent; previous: StickyMatrixEvent }[],
      removed: StickyMatrixEvent[],
  ): void
- Parameters
  - added: StickyMatrixEvent[]
    Any new sticky events with no predecessor events (matching sender, type, and sticky_key)
  - updated: { current: StickyMatrixEvent; previous: StickyMatrixEvent }[]
    Any sticky events that supersede an existing event (matching sender, type, and sticky_key)
  - removed: StickyMatrixEvent[]
    The events that were removed from the map due to expiry.
  Returns void