import { Optional } from "matrix-events-sdk"; import { MatrixClient, PendingEventOrdering } from "../client"; import { MatrixEvent } from "./event"; import { EventTimeline } from "./event-timeline"; import { EventTimelineSet, EventTimelineSetHandlerMap } from "./event-timeline-set"; import { NotificationCountType, Room, RoomEvent } from "./room"; import { RoomState } from "./room-state"; import { ServerControlledNamespacedValue } from "../NamespacedValue"; import { ReadReceipt } from "./read-receipt"; import { CachedReceiptStructure } from "../@types/read_receipts"; export declare enum ThreadEvent { New = "Thread.new", Update = "Thread.update", NewReply = "Thread.newReply", ViewThread = "Thread.viewThread", Delete = "Thread.delete" } type EmittedEvents = Exclude | RoomEvent.Timeline | RoomEvent.TimelineReset; export type EventHandlerMap = { [ThreadEvent.Update]: (thread: Thread) => void; [ThreadEvent.NewReply]: (thread: Thread, event: MatrixEvent) => void; [ThreadEvent.ViewThread]: () => void; [ThreadEvent.Delete]: (thread: Thread) => void; } & EventTimelineSetHandlerMap; interface IThreadOpts { room: Room; client: MatrixClient; pendingEventOrdering?: PendingEventOrdering; receipts?: CachedReceiptStructure[]; } export declare enum FeatureSupport { None = 0, Experimental = 1, Stable = 2 } export declare function determineFeatureSupport(stable: boolean, unstable: boolean): FeatureSupport; export declare class Thread extends ReadReceipt { readonly id: string; rootEvent: MatrixEvent | undefined; static hasServerSideSupport: FeatureSupport; static hasServerSideListSupport: FeatureSupport; static hasServerSideFwdPaginationSupport: FeatureSupport; /** * A reference to all the events ID at the bottom of the threads */ readonly timelineSet: EventTimelineSet; timeline: MatrixEvent[]; private _currentUserParticipated; private reEmitter; private lastEvent; private replyCount; private lastPendingEvent; private pendingReplyCount; readonly room: Room; readonly client: MatrixClient; private readonly pendingEventOrdering; initialEventsFetched: boolean; /** * An array of events to add to the timeline once the thread has been initialised * with server suppport. */ replayEvents: MatrixEvent[] | null; constructor(id: string, rootEvent: MatrixEvent | undefined, opts: IThreadOpts); private fetchRootEvent; static setServerSideSupport(status: FeatureSupport): void; static setServerSideListSupport(status: FeatureSupport): void; static setServerSideFwdPaginationSupport(status: FeatureSupport): void; private onBeforeRedaction; private onRedaction; private onTimelineEvent; private onLocalEcho; private onEcho; get roomState(): RoomState; private addEventToTimeline; addEvents(events: MatrixEvent[], toStartOfTimeline: boolean): void; /** * Add an event to the thread and updates * the tail/root references if needed * Will fire "Thread.update" * @param event - The event to add * @param toStartOfTimeline - whether the event is being added * to the start (and not the end) of the timeline. * @param emit - whether to emit the Update event if the thread was updated or not. */ addEvent(event: MatrixEvent, toStartOfTimeline: boolean, emit?: boolean): Promise; processEvent(event: Optional): Promise; /** * Processes the receipts that were caught during initial sync * When clients become aware of a thread, they try to retrieve those read receipts * and apply them to the current thread * @param receipts - A collection of the receipts cached from initial sync */ private processReceipts; private getRootEventBundledRelationship; private processRootEvent; private updatePendingReplyCount; /** * Reset the live timeline of all timelineSets, and start new ones. * *

This is used when /sync returns a 'limited' timeline. 'Limited' means that there's a gap between the messages * /sync returned, and the last known message in our timeline. In such a case, our live timeline isn't live anymore * and has to be replaced by a new one. To make sure we can continue paginating our timelines correctly, we have to * set new pagination tokens on the old and the new timeline. * * @param backPaginationToken - token for back-paginating the new timeline * @param forwardPaginationToken - token for forward-paginating the old live timeline, * if absent or null, all timelines are reset, removing old ones (including the previous live * timeline which would otherwise be unable to paginate forwards without this token). * Removing just the old live timeline whilst preserving previous ones is not supported. */ resetLiveTimeline(backPaginationToken?: string | null, forwardPaginationToken?: string | null): Promise; private updateThreadMetadata; private fetchEditsWhereNeeded; setEventMetadata(event: Optional): void; clearEventMetadata(event: Optional): void; /** * Finds an event by ID in the current thread */ findEventById(eventId: string): MatrixEvent | undefined; /** * Return last reply to the thread, if known. */ lastReply(matches?: (ev: MatrixEvent) => boolean): MatrixEvent | null; get roomId(): string; /** * The number of messages in the thread * Only count rel_type=m.thread as we want to * exclude annotations from that number */ get length(): number; /** * A getter for the last event of the thread. * This might be a synthesized event, if so, it will not emit any events to listeners. */ get replyToEvent(): Optional; get events(): MatrixEvent[]; has(eventId: string): boolean; get hasCurrentUserParticipated(): boolean; get liveTimeline(): EventTimeline; getUnfilteredTimelineSet(): EventTimelineSet; addReceipt(event: MatrixEvent, synthetic: boolean): void; /** * Get the ID of the event that a given user has read up to within this thread, * or null if we have received no read receipt (at all) from them. * @param userId - The user ID to get read receipt event ID for * @param ignoreSynthesized - If true, return only receipts that have been * sent by the server, not implicit ones generated * by the JS SDK. * @returns ID of the latest event that the given user has read, or null. */ getEventReadUpTo(userId: string, ignoreSynthesized?: boolean): string | null; /** * Determine if the given user has read a particular event. * * It is invalid to call this method with an event that is not part of this thread. * * This is not a definitive check as it only checks the events that have been * loaded client-side at the time of execution. * @param userId - The user ID to check the read state of. * @param eventId - The event ID to check if the user read. * @returns True if the user has read the event, false otherwise. */ hasUserReadEvent(userId: string, eventId: string): boolean; setUnread(type: NotificationCountType, count: number): void; } export declare const FILTER_RELATED_BY_SENDERS: ServerControlledNamespacedValue<"related_by_senders", "io.element.relation_senders">; export declare const FILTER_RELATED_BY_REL_TYPES: ServerControlledNamespacedValue<"related_by_rel_types", "io.element.relation_types">; export declare const THREAD_RELATION_TYPE: ServerControlledNamespacedValue<"m.thread", "io.element.thread">; export declare enum ThreadFilterType { "My" = 0, "All" = 1 } export declare function threadFilterTypeToFilter(type: ThreadFilterType | null): "all" | "participated"; export {}; //# sourceMappingURL=thread.d.ts.map