element-hq/element-x-ios/issues/2876 - Add support for showing call notifications in the timeline

ElementX/Sources/Screens/RoomScreen/View/Timeline/CallNotificationRoomTimelineView.swift

@@ -0,0 +1,78 @@
+//
+// Copyright 2024 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 Compound
+import Foundation
+import SwiftUI
+
+struct CallNotificationRoomTimelineView: View {
+    @EnvironmentObject private var context: RoomScreenViewModel.Context
+    
+    let timelineItem: CallNotificationRoomTimelineItem
+    
+    var body: some View {
+        HStack(spacing: 12) {
+            LoadableAvatarImage(url: timelineItem.sender.avatarURL,
+                                name: timelineItem.sender.displayName ?? timelineItem.sender.id,
+                                contentID: timelineItem.sender.id,
+                                avatarSize: .user(on: .timeline),
+                                imageProvider: context.imageProvider)
+                .accessibilityHidden(true)
+            
+            VStack(alignment: .leading, spacing: 0) {
+                Text(timelineItem.sender.disambiguatedDisplayName ?? timelineItem.sender.id)
+                    .font(.compound.bodyLGSemibold)
+                    .foregroundColor(.compound.textPrimary)
+                    .lineLimit(1)
+                    .frame(maxWidth: .infinity, alignment: .leading)
+                
+                Label(title: { Text(L10n.commonCallStarted) },
+                      icon: { CompoundIcon(\.videoCallSolid, size: .medium, relativeTo: .compound.bodyMD) })
+                    .font(.compound.bodyMD)
+                    .foregroundColor(.compound.textSecondary)
+                    .labelStyle(.custom(spacing: 4))
+            }
+            
+            Spacer()
+            
+            Text(timelineItem.timestamp)
+                .font(.compound.bodyXS)
+                .foregroundColor(.compound.textSecondary)
+        }
+        .padding(12)
+        .overlay(
+            RoundedRectangle(cornerRadius: 8)
+                .stroke(.compound.borderInteractiveSecondary, lineWidth: 1)
+        )
+        .padding(16)
+    }
+}
+
+struct CallNotificationRoomTimelineView_Previews: PreviewProvider, TestablePreview {
+    static let viewModel = RoomScreenViewModel.mock
+    
+    static var previews: some View {
+        body.environmentObject(viewModel.context)
+    }
+    
+    static var body: some View {
+        CallNotificationRoomTimelineView(timelineItem: .init(id: .random,
+                                                             timestamp: "Now",
+                                                             isEditable: false,
+                                                             canBeRepliedTo: false,
+                                                             sender: .init(id: "Bob")))
+    }
+}

ElementX/Sources/Services/Room/RoomSummary/RoomEventStringBuilder.swift

@@ -68,6 +68,8 @@ struct RoomEventStringBuilder {
             return prefix(L10n.commonPollSummary(question), with: displayName)
         case .callInvite:
             return prefix(L10n.commonCallInvite, with: displayName)
+        case .callNotify:
+            return prefix(L10n.commonCallStarted, with: displayName)
         }
     }
     

ElementX/Sources/Services/Timeline/TimelineItems/Items/Other/CallNotificationRoomTimelineItem.swift

@@ -0,0 +1,28 @@
+//
+// Copyright 2024 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
+
+struct CallNotificationRoomTimelineItem: RoomTimelineItemProtocol, Equatable {
+    let id: TimelineItemIdentifier
+    let timestamp: String
+    let isEditable: Bool
+    let canBeRepliedTo: Bool
+    
+    let sender: TimelineItemSender
+    
+    var properties = RoomTimelineItemProperties()
+}

ElementX/Sources/Services/Timeline/TimelineItems/RoomTimelineItemFactory.swift

@@ -75,6 +75,8 @@ struct RoomTimelineItemFactory: RoomTimelineItemFactoryProtocol {
             return buildPollTimelineItem(question, kind, maxSelections, answers, votes, endTime, eventItemProxy, isOutgoing, edited)
         case .callInvite:
             return buildCallInviteTimelineItem(for: eventItemProxy)
+        case .callNotify:
+            return buildCallNotificationTimelineItem(for: eventItemProxy)
         }
     }
     
@@ -438,6 +440,14 @@ struct RoomTimelineItemFactory: RoomTimelineItemFactoryProtocol {
                                    sender: eventItemProxy.sender)
     }
     
+    private func buildCallNotificationTimelineItem(for eventItemProxy: EventTimelineItemProxy) -> RoomTimelineItemProtocol {
+        CallNotificationRoomTimelineItem(id: eventItemProxy.id,
+                                         timestamp: eventItemProxy.timestamp.formatted(date: .omitted, time: .shortened),
+                                         isEditable: eventItemProxy.isEditable,
+                                         canBeRepliedTo: eventItemProxy.canBeRepliedTo,
+                                         sender: eventItemProxy.sender)
+    }
+    
     private func aggregateReactions(_ reactions: [Reaction]) -> [AggregatedReaction] {
         reactions.map { reaction in
             let senders = reaction.senders

ElementX/Sources/Services/Timeline/TimelineItems/RoomTimelineItemView.swift

@@ -76,6 +76,8 @@ struct RoomTimelineItemView: View {
             VoiceMessageRoomTimelineView(timelineItem: item, playerState: context?.viewState.audioPlayerStateProvider?(item.id) ?? AudioPlayerState(id: .timelineItemIdentifier(item.id), duration: 0))
         case .callInvite(let item):
             CallInviteRoomTimelineView(timelineItem: item)
+        case .callNotification(let item):
+            CallNotificationRoomTimelineView(timelineItem: item)
         }
     }
 }

ElementX/Sources/Services/Timeline/TimelineItems/RoomTimelineItemViewState.swift

@@ -66,6 +66,7 @@ enum RoomTimelineItemType: Equatable {
     case poll(PollRoomTimelineItem)
     case voice(VoiceMessageRoomTimelineItem)
     case callInvite(CallInviteRoomTimelineItem)
+    case callNotification(CallNotificationRoomTimelineItem)
 
     init(item: RoomTimelineItemProtocol) {
         switch item {
@@ -111,6 +112,8 @@ enum RoomTimelineItemType: Equatable {
             self = .voice(item)
         case let item as CallInviteRoomTimelineItem:
             self = .callInvite(item)
+        case let item as CallNotificationRoomTimelineItem:
+            self = .callNotification(item)
         default:
             fatalError("Unknown timeline item")
         }
@@ -138,7 +141,8 @@ enum RoomTimelineItemType: Equatable {
              .location(let item as RoomTimelineItemProtocol),
              .poll(let item as RoomTimelineItemProtocol),
              .voice(let item as RoomTimelineItemProtocol),
-             .callInvite(let item as RoomTimelineItemProtocol):
+             .callInvite(let item as RoomTimelineItemProtocol),
+             .callNotification(let item as RoomTimelineItemProtocol):
             return item.id
         }
     }