Support for updating name and metadata of LocalParticipant (#201)

Author: hiroshihorie

Sources/LiveKit/Core/SignalClient.swift

@@ -582,6 +582,20 @@ internal extension SignalClient {
         return sendRequest(r)
     }
 
+    func sendUpdateLocalMetadata(_ metadata: String, name: String) -> Promise<Void> {
+
+        log()
+
+        let r = Livekit_SignalRequest.with {
+            $0.updateMetadata = Livekit_UpdateParticipantMetadata.with {
+                $0.metadata = metadata
+                $0.name = name
+            }
+        }
+
+        return sendRequest(r)
+    }
+
     func sendSyncState(answer: Livekit_SessionDescription,
                        offer: Livekit_SessionDescription?,
                        subscription: Livekit_UpdateSubscription,

Sources/LiveKit/Participant/LocalParticipant.swift

@@ -344,6 +344,30 @@ public class LocalParticipant: Participant {
         return sendTrackSubscriptionPermissions()
     }
 
+    /// Sets and updates the metadata of the local participant.
+    ///
+    /// Note: this requires `CanUpdateOwnMetadata` permission encoded in the token.
+    public func set(metadata: String) -> Promise<Void> {
+        // mutate state to set metadata and copy name from state
+        let name = _state.mutate {
+            $0.metadata = metadata
+            return $0.name
+        }
+        return room.engine.signalClient.sendUpdateLocalMetadata(metadata, name: name)
+    }
+
+    /// Sets and updates the name of the local participant.
+    ///
+    /// Note: this requires `CanUpdateOwnMetadata` permission encoded in the token.
+    public func set(name: String) -> Promise<Void> {
+        // mutate state to set name and copy metadata from state
+        let metadata = _state.mutate {
+            $0.name = name
+            return $0.metadata
+        }
+        return room.engine.signalClient.sendUpdateLocalMetadata(metadata ?? "", name: name)
+    }
+
     internal func sendTrackSubscriptionPermissions() -> Promise<Void> {
 
         guard room.engine._state.connectionState == .connected else {

Sources/LiveKit/Participant/Participant.swift

@@ -129,7 +129,20 @@ public class Participant: NSObject, ObservableObject, Loggable {
                 }
             }
 
+            // name updated
+            if newState.name != oldState.name {
+                // notfy participant delegates
+                self.delegates.notify(label: { "participant.didUpdateName: \(newState.name)" }) {
+                    $0.participant?(self, didUpdateName: newState.name)
+                }
+                // notify room delegates
+                self.room.delegates.notify(label: { "room.didUpdateName: \(newState.name)" }) {
+                    $0.room?(self.room, participant: self, didUpdateName: newState.name)
+                }
+            }
+
             if newState.connectionQuality != oldState.connectionQuality {
+
                 self.delegates.notify(label: { "participant.didUpdate connectionQuality: \(self.connectionQuality)" }) {
                     $0.participant?(self, didUpdate: self.connectionQuality)
                 }

Sources/LiveKit/Protocols/ParticipantDelegate.swift

@@ -32,6 +32,11 @@ public protocol ParticipantDelegate: AnyObject {
     @objc(participant:didUpdateMetadata:) optional
     func participant(_ participant: Participant, didUpdate metadata: String?)
 
+    /// A ``Participant``'s name has updated.
+    /// `participant` Can be a ``LocalParticipant`` or a ``RemoteParticipant``.
+    @objc(participant:didUpdateName:) optional
+    func participant(_ participant: Participant, didUpdateName: String)
+
     /// The isSpeaking status of a ``Participant`` has changed.
     /// `participant` Can be a ``LocalParticipant`` or a ``RemoteParticipant``.
     @objc(participant:didUpdateSpeaking:) optional

Sources/LiveKit/Protocols/RoomDelegate.swift

@@ -77,6 +77,10 @@ public protocol RoomDelegateObjC: AnyObject {
     @objc(room:participant:didUpdateMetadata:) optional
     func room(_ room: Room, participant: Participant, didUpdate metadata: String?)
 
+    /// Same with ``ParticipantDelegate/participant(_:didUpdateName:)``.
+    @objc(room:participant:didUpdateName:) optional
+    func room(_ room: Room, participant: Participant, didUpdateName: String)
+
     /// Same with ``ParticipantDelegate/participant(_:didUpdate:)-7zxk1``.
     @objc(room:participant:didUpdateConnectionQuality:) optional
     func room(_ room: Room, participant: Participant, didUpdate connectionQuality: ConnectionQuality)