1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
import { MatrixEvent } from "./event";
import { RelationType } from "../@types/event";
import { TypedEventEmitter } from "./typed-event-emitter";
import { MatrixClient } from "../client";
import { Room } from "./room";
export declare enum RelationsEvent {
Add = "Relations.add",
Remove = "Relations.remove",
Redaction = "Relations.redaction"
}
export type EventHandlerMap = {
[RelationsEvent.Add]: (event: MatrixEvent) => void;
[RelationsEvent.Remove]: (event: MatrixEvent) => void;
[RelationsEvent.Redaction]: (event: MatrixEvent) => void;
};
/**
* 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.
*/
export declare class Relations extends TypedEventEmitter<RelationsEvent, EventHandlerMap> {
readonly relationType: RelationType | string;
readonly eventType: string;
readonly altEventTypes?: string[] | undefined;
private relationEventIds;
private relations;
private annotationsByKey;
private annotationsBySender;
private sortedAnnotationsByKey;
private targetEvent;
private creationEmitted;
private readonly client;
/**
* @param relationType - The type of relation involved, such as "m.annotation", "m.reference", "m.replace", etc.
* @param eventType - The relation event's type, such as "m.reaction", etc.
* @param client - The client which created this instance. For backwards compatibility also accepts a Room.
* @param altEventTypes - alt event types for relation events, for example to support unstable prefixed event types
*/
constructor(relationType: RelationType | string, eventType: string, client: MatrixClient | Room, altEventTypes?: string[] | undefined);
/**
* Add relation events to this collection.
*
* @param event - The new relation event to be added.
*/
addEvent(event: MatrixEvent): Promise<void>;
/**
* Remove relation event from this collection.
*
* @param event - The relation event to remove.
*/
removeEvent(event: MatrixEvent): Promise<void>;
/**
* Listens for event status changes to remove cancelled events.
*
* @param event - The event whose status has changed
* @param status - The new status
*/
private onEventStatus;
/**
* 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.
*/
getRelations(): MatrixEvent[];
private addAnnotationToAggregation;
private removeAnnotationFromAggregation;
/**
* 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
*
* @param redactedEvent - The original relation event that is about to be redacted.
*/
private onBeforeRedaction;
/**
* 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).
*/
getSortedAnnotationsByKey(): [string, Set<MatrixEvent>][] | null;
/**
* 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.
*/
getAnnotationsBySender(): Record<string, Set<MatrixEvent>> | null;
/**
* 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`.
*/
getLastReplacement(): Promise<MatrixEvent | null>;
setTargetEvent(event: MatrixEvent): Promise<void>;
private maybeEmitCreated;
}
//# sourceMappingURL=relations.d.ts.map
|
