Add RoomCoordinator.

2026-04-30 21:26:57 +02:00 · 2021-10-05 09:41:04 +02:00
parent 943d35afb1
commit 1c0d9d222e
5 changed files with 516 additions and 0 deletions
@@ -0,0 +1,76 @@
+// 
+// Copyright 2021 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import Foundation
+
+/// RoomCoordinator input parameters
+struct RoomCoordinatorParameters {
+    
+    // MARK: - Properties
+    
+    /// The navigation router that manage physical navigation
+    let navigationRouter: NavigationRouterType?
+    
+    /// The navigation router store that enables to get a NavigationRouter from a navigation controller
+    /// `navigationRouter` property takes priority on `navigationRouterStore`
+    let navigationRouterStore: NavigationRouterStoreProtocol?
+    
+    /// The matrix session in which the room should be available.
+    let session: MXSession
+    
+    /// The room identifier
+    let roomId: String
+    
+    /// If not nil, the room will be opened on this event.
+    let eventId: String?
+    
+    /// The data for the room preview.
+    let previewData: RoomPreviewData?
+    
+    // MARK: - Setup
+    
+    private init(navigationRouter: NavigationRouterType?,
+                 navigationRouterStore: NavigationRouterStoreProtocol?,
+                 session: MXSession,
+                 roomId: String,
+                 eventId: String?,
+                 previewData: RoomPreviewData?) {
+        self.navigationRouter = navigationRouter
+        self.navigationRouterStore = navigationRouterStore
+        self.session = session
+        self.roomId = roomId
+        self.eventId = eventId
+        self.previewData = previewData
+    }
+    
+    /// Init to present a joined room
+    init(navigationRouter: NavigationRouterType? = nil,
+         navigationRouterStore: NavigationRouterStoreProtocol? = nil,
+         session: MXSession,
+         roomId: String,
+         eventId: String? = nil) {
+        
+        self.init(navigationRouter: navigationRouter, navigationRouterStore: navigationRouterStore, session: session, roomId: roomId, eventId: eventId, previewData: nil)
+    }
+    
+    /// Init to present a room preview
+    init(navigationRouter: NavigationRouterType? = nil,
+         navigationRouterStore: NavigationRouterStoreProtocol? = nil,
+         previewData: RoomPreviewData) {
+        
+        self.init(navigationRouter: navigationRouter, navigationRouterStore: navigationRouterStore, session: previewData.mxSession, roomId: previewData.roomId, eventId: nil, previewData: previewData)
+    }
+}