Join room loading indicators

Riot/Modules/Common/UserIndicators/UserIndicatorStore.swift

@@ -0,0 +1,54 @@
+// 
+// Copyright 2022 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
+import CommonKit
+
+/// An abstraction on top of `UserIndicatorTypePresenterProtocol` which manages and stores the individual user indicators.
+/// When used to present an indicator the `UserIndicatorStore` will instead returns a simple callback function to the clients
+/// letting them cancel the indicators without worrying about memory.
+@objc final class UserIndicatorStore: NSObject {
+    private let presenter: UserIndicatorTypePresenterProtocol
+    private var indicators: [UserIndicator]
+    
+    init(presenter: UserIndicatorTypePresenterProtocol) {
+        self.presenter = presenter
+        self.indicators = []
+    }
+    
+    /// Present a new type of user indicator, such as loading spinner or success message.
+    /// To remove an indicator, call the returned `UserIndicatorCancel` function
+    func present(type: UserIndicatorType) -> UserIndicatorCancel {
+        let indicator = presenter.present(type)
+        indicators.append(indicator)
+        return {
+            indicator.cancel()
+        }
+    }
+    
+    /// Present a new type of user indicator, such as loading spinner or success message.
+    /// To remove an indicator, call the returned `UserIndicatorCancel` function
+    ///
+    /// Note: This is a convenience function callable by objective-c code
+    @objc func presentLoading(label: String, isInteractionBlocking: Bool) -> UserIndicatorCancel {
+        present(
+            type: .loading(
+                label: label,
+                isInteractionBlocking: isInteractionBlocking
+            )
+        )
+    }
+}