Add timeline properties for edited and reactions.

Not yet visible, waiting for timeline API.
2026-11-03 16:10:20 +00:00 · 2022-09-14 10:43:58 +01:00
parent 2986f85bcb
commit 7dd77be01b
26 changed files with 329 additions and 37 deletions
@@ -30,14 +30,18 @@ class MockRoomTimelineController: RoomTimelineControllerProtocol {
                                                                          shouldShowSenderDetails: true,
                                                                          isOutgoing: false,
                                                                          senderId: "",
-                                                                          senderDisplayName: "Some user with a really long long long long long display name"),
+                                                                          senderDisplayName: "Some user with a really long long long long long display name",
+                                                                          properties: RoomTimelineItemProperties(isEdited: true)),
                                                     TextRoomTimelineItem(id: UUID().uuidString,
                                                                          text: "You also rule!",
                                                                          timestamp: "10:11 AM",
                                                                          shouldShowSenderDetails: false,
                                                                          isOutgoing: false,
                                                                          senderId: "",
-                                                                          senderDisplayName: "Alice"),
+                                                                          senderDisplayName: "Alice",
+                                                                          properties: RoomTimelineItemProperties(reactions: [
+                                                                              AggregatedReaction(key: "🙌", count: 1, isHighlighted: true)
+                                                                          ])),
                                                     SeparatorRoomTimelineItem(id: UUID().uuidString,
                                                                               text: "Today"),
                                                     TextRoomTimelineItem(id: UUID().uuidString,
@@ -46,7 +50,11 @@ class MockRoomTimelineController: RoomTimelineControllerProtocol {
                                                                          shouldShowSenderDetails: false,
                                                                          isOutgoing: true,
                                                                          senderId: "",
-                                                                          senderDisplayName: "Bob")]
+                                                                          senderDisplayName: "Bob",
+                                                                          properties: RoomTimelineItemProperties(reactions: [
+                                                                              AggregatedReaction(key: "🙏", count: 1, isHighlighted: false),
+                                                                              AggregatedReaction(key: "😁", count: 3, isHighlighted: false)
+                                                                          ]))]
    
    func paginateBackwards(_ count: UInt) async -> Result<Void, RoomTimelineControllerError> {
        .failure(.generic)
@@ -0,0 +1,27 @@
+//
+// 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
+
+/// Represents all reactions of the same type for a single event.
+struct AggregatedReaction: Equatable, Hashable {
+    /// The reaction that was sent.
+    let key: String
+    /// The number of times this reactions was sent.
+    let count: Int
+    /// Whether to highlight the reaction, indicating that the current user sent this reaction.
+    let isHighlighted: Bool
+}
@@ -26,4 +26,6 @@ protocol EventBasedTimelineItemProtocol: RoomTimelineItemProtocol {
    var senderId: String { get }
    var senderDisplayName: String? { get set }
    var senderAvatar: UIImage? { get set }
+    
+    var properties: RoomTimelineItemProperties { get }
 }
@@ -28,4 +28,6 @@ struct EmoteRoomTimelineItem: EventBasedTimelineItemProtocol, Identifiable, Equa
    let senderId: String
    var senderDisplayName: String?
    var senderAvatar: UIImage?
+    
+    let properties: RoomTimelineItemProperties
 }
@@ -35,4 +35,6 @@ struct ImageRoomTimelineItem: EventBasedTimelineItemProtocol, Identifiable, Equa
    var height: CGFloat?
    var aspectRatio: CGFloat?
    var blurhash: String?
+    
+    let properties: RoomTimelineItemProperties
 }
@@ -28,4 +28,6 @@ struct NoticeRoomTimelineItem: EventBasedTimelineItemProtocol, Identifiable, Equ
    let senderId: String
    var senderDisplayName: String?
    var senderAvatar: UIImage?
+    
+    let properties: RoomTimelineItemProperties
 }
@@ -0,0 +1,25 @@
+//
+// 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
+
+/// Properties of a matrix event that are common between all timeline items.
+struct RoomTimelineItemProperties: Equatable {
+    /// Whether the item has been edited.
+    var isEdited = false
+    /// The aggregated reactions that have been sent for this item.
+    var reactions: [AggregatedReaction] = []
+}
@@ -28,4 +28,6 @@ struct TextRoomTimelineItem: EventBasedTimelineItemProtocol, Identifiable, Equat
    let senderId: String
    var senderDisplayName: String?
    var senderAvatar: UIImage?
+    
+    let properties: RoomTimelineItemProperties
 }
@@ -67,7 +67,8 @@ struct RoomTimelineItemFactory: RoomTimelineItemFactoryProtocol {
                                    isOutgoing: isOutgoing,
                                    senderId: message.sender,
                                    senderDisplayName: displayName,
-                                    senderAvatar: avatarImage)
+                                    senderAvatar: avatarImage,
+                                    properties: RoomTimelineItemProperties())
    }
    
    private func buildImageTimelineItemFromMessage(_ message: ImageRoomMessage,
@@ -94,7 +95,8 @@ struct RoomTimelineItemFactory: RoomTimelineItemFactoryProtocol {
                                     width: message.width,
                                     height: message.height,
                                     aspectRatio: aspectRatio,
-                                     blurhash: message.blurhash)
+                                     blurhash: message.blurhash,
+                                     properties: RoomTimelineItemProperties())
    }
    
    private func buildNoticeTimelineItemFromMessage(_ message: NoticeRoomMessage,
@@ -113,7 +115,8 @@ struct RoomTimelineItemFactory: RoomTimelineItemFactoryProtocol {
                                      isOutgoing: isOutgoing,
                                      senderId: message.sender,
                                      senderDisplayName: displayName,
-                                      senderAvatar: avatarImage)
+                                      senderAvatar: avatarImage,
+                                      properties: RoomTimelineItemProperties())
    }
    
    private func buildEmoteTimelineItemFromMessage(_ message: EmoteRoomMessage,
@@ -132,6 +135,7 @@ struct RoomTimelineItemFactory: RoomTimelineItemFactoryProtocol {
                                     isOutgoing: isOutgoing,
                                     senderId: message.sender,
                                     senderDisplayName: displayName,
-                                     senderAvatar: avatarImage)
+                                     senderAvatar: avatarImage,
+                                     properties: RoomTimelineItemProperties())
    }
 }