blob: 2b5b74892a8d43f8763a35409abe3cf3fc07526d (
plain)
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
|
import { MatrixEvent } from "./event";
export declare class EventContext {
readonly ourEvent: MatrixEvent;
private timeline;
private ourEventIndex;
private paginateTokens;
/**
* Construct a new EventContext
*
* An eventcontext is used for circumstances such as search results, when we
* have a particular event of interest, and a bunch of events before and after
* it.
*
* It also stores pagination tokens for going backwards and forwards in the
* timeline.
*
* @param ourEvent - the event at the centre of this context
*/
constructor(ourEvent: MatrixEvent);
/**
* Get the main event of interest
*
* This is a convenience function for getTimeline()[getOurEventIndex()].
*
* @returns The event at the centre of this context.
*/
getEvent(): MatrixEvent;
/**
* Get the list of events in this context
*
* @returns An array of MatrixEvents
*/
getTimeline(): MatrixEvent[];
/**
* Get the index in the timeline of our event
*/
getOurEventIndex(): number;
/**
* Get a pagination token.
*
* @param backwards - true to get the pagination token for going
*/
getPaginateToken(backwards?: boolean): string | null;
/**
* Set a pagination token.
*
* Generally this will be used only by the matrix js sdk.
*
* @param token - pagination token
* @param backwards - true to set the pagination token for going
* backwards in time
*/
setPaginateToken(token?: string, backwards?: boolean): void;
/**
* Add more events to the timeline
*
* @param events - new events, in timeline order
* @param atStart - true to insert new events at the start
*/
addEvents(events: MatrixEvent[], atStart?: boolean): void;
}
//# sourceMappingURL=event-context.d.ts.map
|
