Class Relations

A container for relation events that supports easy access to common ways of aggregating such events. Each instance holds events that of a single relation type and event type. All of the events also relate to the same original event.

The typical way to get one of these containers is via EventTimelineSet#getRelationsForEvent.

Hierarchy

TypedEventEmitter<RelationsEvent, EventHandlerMap>
- Relations

Constructors

constructor

new Relations(relationType: string, eventType: string, client: MatrixClient | Room, altEventTypes?: string[]): Relations
Parameters
- relationType: string
  
  The type of relation involved, such as "m.annotation", "m.reference", "m.replace", etc.
- eventType: string
  
  The relation event's type, such as "m.reaction", etc.
- client: MatrixClient | Room
  
  The client which created this instance. For backwards compatibility also accepts a Room.
- Optional altEventTypes: string[]
  
  alt event types for relation events, for example to support unstable prefixed event types
Returns Relations
Overrides TypedEventEmitter.constructor
- Defined in src/models/relations.ts:63

Properties

`Optional` `Readonly` altEventTypes

altEventTypes?: string[]

alt event types for relation events, for example to support unstable prefixed event types

`Private` annotationsByKey

annotationsByKey: Record<string, Set<MatrixEvent>> = {}

`Private` annotationsBySender

annotationsBySender: Record<string, Set<MatrixEvent>> = {}

`Private` `Readonly` client

client: MatrixClient

`Private` creationEmitted

creationEmitted: boolean = false

`Readonly` eventType

eventType: string

The relation event's type, such as "m.reaction", etc.

`Private` relationEventIds

relationEventIds: Set<string> = ...

`Readonly` relationType

relationType: string

The type of relation involved, such as "m.annotation", "m.reference", "m.replace", etc.

`Private` relations

relations: Set<MatrixEvent> = ...

`Private` sortedAnnotationsByKey

sortedAnnotationsByKey: [string, Set<MatrixEvent>][] = []

`Private` targetEvent

targetEvent: null | MatrixEvent = null

Methods

`Private` addAnnotationToAggregation

addAnnotationToAggregation(event: MatrixEvent): void
Parameters
- event: MatrixEvent
Returns void
- Defined in src/models/relations.ts:175

addEvent

addEvent(event: MatrixEvent): Promise<void>
Add relation events to this collection.
Parameters
- event: MatrixEvent
  
  The new relation event to be added.
Returns Promise<void>
- Defined in src/models/relations.ts:78

addListener

addListener<T>(event: T, listener: Listener<RelationsEvent, EventHandlerMap, T>): Relations
Type Parameters
- T extends EventEmitterEvents | RelationsEvent
Parameters
- event: T
- listener: Listener<RelationsEvent, EventHandlerMap, T>
Returns Relations
Inherited from TypedEventEmitter.addListener
- Defined in src/models/typed-event-emitter.ts:49

emit

emit<T>(event: T, ...args: Parameters<EventHandlerMap[T]>): boolean
Type Parameters
- T extends RelationsEvent
Parameters
- event: T
- Rest ...args: Parameters<EventHandlerMap[T]>
Returns boolean
Inherited from TypedEventEmitter.emit
- Defined in src/models/typed-event-emitter.ts:56
emit<T>(event: T, ...args: Parameters<EventHandlerMap[T]>): boolean
Type Parameters
- T extends RelationsEvent
Parameters
- event: T
- Rest ...args: Parameters<EventHandlerMap[T]>
Returns boolean
Inherited from TypedEventEmitter.emit
- Defined in src/models/typed-event-emitter.ts:57

eventNames

eventNames(): (EventEmitterEvents | RelationsEvent)[]
Returns (EventEmitterEvents | RelationsEvent)[]
Inherited from TypedEventEmitter.eventNames
- Defined in src/models/typed-event-emitter.ts:62

getAnnotationsBySender

getAnnotationsBySender(): null | Record<string, Set<MatrixEvent>>
Get all events in this collection grouped by sender.

This is currently only supported for the annotation relation type.

An object with each relation sender as a key and the matching Set of events for that sender as a value.

Returns null | Record<string, Set<MatrixEvent>>
- Defined in src/models/relations.ts:281

getLastReplacement

getLastReplacement(): Promise<null | MatrixEvent>
Returns the most recent (and allowed) m.replace relation, if any.

This is currently only supported for the m.replace relation type, once the target event is known, see addEvent.

Returns Promise<null | MatrixEvent>
- Defined in src/models/relations.ts:296

getRelations

getRelations(): MatrixEvent[]
Get all relation events in this collection.

These are currently in the order of insertion to this collection, which won't match timeline order in the case of scrollback. TODO: Tweak addEvent to insert correctly for scrollback.

Relation events in insertion order.

Returns MatrixEvent[]
- Defined in src/models/relations.ts:171

getSortedAnnotationsByKey

getSortedAnnotationsByKey(): null | [string, Set<MatrixEvent>][]
Get all events in this collection grouped by key and sorted by descending event count in each group.

This is currently only supported for the annotation relation type.

An array of [key, events] pairs sorted by descending event count. The events are stored in a Set (which preserves insertion order).

Returns null | [string, Set<MatrixEvent>][]
- Defined in src/models/relations.ts:264

listenerCount

listenerCount(event: EventEmitterEvents | RelationsEvent): number
Parameters
- event: EventEmitterEvents | RelationsEvent
Returns number
Inherited from TypedEventEmitter.listenerCount
- Defined in src/models/typed-event-emitter.ts:66

listeners

listeners(event: EventEmitterEvents | RelationsEvent): Function[]
Parameters
- event: EventEmitterEvents | RelationsEvent
Returns Function[]
Inherited from TypedEventEmitter.listeners
- Defined in src/models/typed-event-emitter.ts:70

`Private` maybeEmitCreated

maybeEmitCreated(): void
Returns void
- Defined in src/models/relations.ts:356

off

off<T>(event: T, listener: Listener<RelationsEvent, EventHandlerMap, T>): Relations
Type Parameters
- T extends EventEmitterEvents | RelationsEvent
Parameters
- event: T
- listener: Listener<RelationsEvent, EventHandlerMap, T>
Returns Relations
Inherited from TypedEventEmitter.off
- Defined in src/models/typed-event-emitter.ts:74

on

on<T>(event: T, listener: Listener<RelationsEvent, EventHandlerMap, T>): Relations
Type Parameters
- T extends EventEmitterEvents | RelationsEvent
Parameters
- event: T
- listener: Listener<RelationsEvent, EventHandlerMap, T>
Returns Relations
Inherited from TypedEventEmitter.on
- Defined in src/models/typed-event-emitter.ts:78

`Private` onBeforeRedaction

onBeforeRedaction(redactedEvent: MatrixEvent): Promise<void>
For relations that have been redacted, we want to remove them from aggregation data sets and emit an update event.

To do so, we listen for Event.beforeRedaction, which happens:
- after the server accepted the redaction and remote echoed back to us
- before the original event has been marked redacted in the client
Parameters
- redactedEvent: MatrixEvent
  
  The original relation event that is about to be redacted.
Returns Promise<void>
- Defined in src/models/relations.ts:235

`Private` onEventStatus

onEventStatus(event: MatrixEvent, status: null | EventStatus): void
Listens for event status changes to remove cancelled events.
Parameters
- event: MatrixEvent
  
  The event whose status has changed
- status: null | EventStatus
  
  The new status
Returns void
- Defined in src/models/relations.ts:148

`Private` removeAnnotationFromAggregation

removeAnnotationFromAggregation(event: MatrixEvent): void
Parameters
- event: MatrixEvent
Returns void
- Defined in src/models/relations.ts:202

removeEvent

removeEvent(event: MatrixEvent): Promise<void>
Remove relation event from this collection.
Parameters
- event: MatrixEvent
  
  The relation event to remove.
Returns Promise<void>
- Defined in src/models/relations.ts:125

removeListener

removeListener<T>(event: T, listener: Listener<RelationsEvent, EventHandlerMap, T>): Relations
Type Parameters
- T extends EventEmitterEvents | RelationsEvent
Parameters
- event: T
- listener: Listener<RelationsEvent, EventHandlerMap, T>
Returns Relations
Inherited from TypedEventEmitter.removeListener
- Defined in src/models/typed-event-emitter.ts:104

setTargetEvent

setTargetEvent(event: MatrixEvent): Promise<void>
Parameters
- event: MatrixEvent
Returns Promise<void>
- Defined in src/models/relations.ts:338

Class Relations

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

relationType: string

eventType: string

client: MatrixClient | Room

Optional altEventTypes: string[]

Returns Relations

Properties

Optional Readonly altEventTypes

Private annotationsByKey

Private annotationsBySender

Private Readonly client

Private creationEmitted

Readonly eventType

Private relationEventIds

Readonly relationType

Private relations

Private sortedAnnotationsByKey

Private targetEvent

Methods

Private addAnnotationToAggregation

Parameters

event: MatrixEvent

Returns void

addEvent

Parameters

event: MatrixEvent

Returns Promise<void>

addListener

Type Parameters

T extends EventEmitterEvents | RelationsEvent

Parameters

event: T

listener: Listener<RelationsEvent, EventHandlerMap, T>

Returns Relations

emit

Type Parameters

T extends RelationsEvent

Parameters

event: T

Rest ...args: Parameters<EventHandlerMap[T]>

Returns boolean

Type Parameters

T extends RelationsEvent

Parameters

event: T

Rest ...args: Parameters<EventHandlerMap[T]>

Returns boolean

eventNames

Returns (EventEmitterEvents | RelationsEvent)[]

getAnnotationsBySender

Returns null | Record<string, Set<MatrixEvent>>

getLastReplacement

Returns Promise<null | MatrixEvent>

getRelations

Returns MatrixEvent[]

getSortedAnnotationsByKey

Returns null | [string, Set<MatrixEvent>][]

listenerCount

Parameters

event: EventEmitterEvents | RelationsEvent

Returns number

listeners

Parameters

event: EventEmitterEvents | RelationsEvent

Returns Function[]

Private maybeEmitCreated

Returns void

off

Type Parameters

T extends EventEmitterEvents | RelationsEvent

Parameters

event: T

`Optional` altEventTypes: string[]

`Optional` `Readonly` altEventTypes

`Private` annotationsByKey

`Private` annotationsBySender

`Private` `Readonly` client

`Private` creationEmitted

`Readonly` eventType

`Private` relationEventIds

`Readonly` relationType

`Private` relations

`Private` sortedAnnotationsByKey

`Private` targetEvent

`Private` addAnnotationToAggregation

`Rest` ...args: Parameters<EventHandlerMap[T]>

`Rest` ...args: Parameters<EventHandlerMap[T]>

`Private` maybeEmitCreated

`Private` onBeforeRedaction

`Private` onEventStatus

`Optional` event: EventEmitterEvents | RelationsEvent

`Private` removeAnnotationFromAggregation