RoomTimeline… refactor (drop the Room). (#3728)

* Add the timeline controller factory to the timeline view model. In preparation for building a timeline to swipe through media in QuickLook. * Refactor RoomTimelineControllerFactory. * Refactor RoomTimelineController. * Refactor RoomTimelineProvider.
2026-11-05 11:58:32 +00:00 · 2025-02-03 14:14:01 +00:00
parent 9df5a8fddb
commit d195e603c9
53 changed files with 688 additions and 631 deletions
@@ -0,0 +1,86 @@
+//
+// Copyright 2022-2024 New Vector Ltd.
+//
+// SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
+// Please see LICENSE files in the repository root for full details.
+//
+
+import Combine
+import MatrixRustSDK
+import SwiftUI
+
+enum TimelineControllerCallback {
+    case updatedTimelineItems(timelineItems: [RoomTimelineItemProtocol], isSwitchingTimelines: Bool)
+    case paginationState(PaginationState)
+    case isLive(Bool)
+}
+
+enum TimelineControllerAction {
+    case displayMediaFile(file: MediaFileHandleProxy, title: String?)
+    case displayLocation(body: String, geoURI: GeoURI, description: String?)
+    case none
+}
+
+enum TimelineControllerError: Error {
+    case generic
+    case eventNotFound
+}
+
+@MainActor
+protocol TimelineControllerProtocol {
+    var roomID: String { get }
+    var timelineKind: TimelineKind { get }
+    
+    /// The currently known items, use only for setting up the intial state.
+    var timelineItems: [RoomTimelineItemProtocol] { get }
+    
+    /// The current pagination state, use only for setting up the intial state
+    var paginationState: PaginationState { get }
+    
+    var callbacks: PassthroughSubject<TimelineControllerCallback, Never> { get }
+    
+    func processItemAppearance(_ itemID: TimelineItemIdentifier) async
+    
+    func processItemDisappearance(_ itemID: TimelineItemIdentifier) async
+    
+    func focusOnEvent(_ eventID: String, timelineSize: UInt16) async -> Result<Void, TimelineControllerError>
+    func focusLive()
+    
+    func paginateBackwards(requestSize: UInt16) async -> Result<Void, TimelineControllerError>
+    func paginateForwards(requestSize: UInt16) async -> Result<Void, TimelineControllerError>
+    
+    func sendReadReceipt(for itemID: TimelineItemIdentifier) async
+    
+    func sendMessage(_ message: String,
+                     html: String?,
+                     inReplyToEventID: String?,
+                     intentionalMentions: IntentionalMentions) async
+    
+    func edit(_ eventOrTransactionID: EventOrTransactionId,
+              message: String,
+              html: String?,
+              intentionalMentions: IntentionalMentions) async
+    
+    func editCaption(_ eventOrTransactionID: EventOrTransactionId,
+                     message: String,
+                     html: String?,
+                     intentionalMentions: IntentionalMentions) async
+    
+    func removeCaption(_ eventOrTransactionID: EventOrTransactionId) async
+    
+    func toggleReaction(_ reaction: String, to eventOrTransactionID: EventOrTransactionId) async
+
+    func redact(_ eventOrTransactionID: EventOrTransactionId) async
+    
+    func pin(eventID: String) async
+    
+    func unpin(eventID: String) async
+    
+    func messageEventContent(for itemID: TimelineItemIdentifier) async -> RoomMessageEventContentWithoutRelation?
+    
+    func debugInfo(for itemID: TimelineItemIdentifier) -> TimelineItemDebugInfo
+    
+    func sendHandle(for itemID: TimelineItemIdentifier) -> SendHandleProxy?
+    
+    func eventTimestamp(for itemID: TimelineItemIdentifier) -> Date?
+}