Merge pull request #246453 from lucianopa-msft/lucianopa/ufd-docs-update

[AzureCommunicationCalling][Native] Adjust UFD documentation for GA

Author: v-shils

articles/communication-services/concepts/voice-video-calling/includes/user-facing-diagnostics-android.md

@@ -17,15 +17,15 @@ ms.subservice: calling
 User-facing diagnostics is an extended feature of the core `Call` API and allows you to diagnose an active call.
 
 ```java
-DiagnosticsCallFeature diagnosticsCallFeature = call.feature(Features.DIAGNOSTICS_CALL);
+DiagnosticsCallFeature diagnosticsCallFeature = call.feature(Features.LOCAL_USER_DIAGNOSTICS);
 ```
 
 ## User Facing Diagnostic events
 
 - Get feature object and add listeners to the diagnostics events.
 
 ```java
-DiagnosticsCallFeature diagnosticsCallFeature = call.feature(Features.DIAGNOSTICS_CALL);
+DiagnosticsCallFeature diagnosticsCallFeature = call.feature(Features.LOCAL_USER_DIAGNOSTICS);
 
 /* NetworkDiagnostic */
 FlagDiagnosticChangedListener listener = (FlagDiagnosticChangedEvent args) -> {
@@ -34,36 +34,36 @@ FlagDiagnosticChangedListener listener = (FlagDiagnosticChangedEvent args) -> {
 };
 
 NetworkDiagnostics networkDiagnostics = diagnosticsCallFeature.getNetworkDiagnostics();
-networkDiagnostics.addOnNoNetworkChangedListener(listener);
+networkDiagnostics.addOnNetworkUnreachableChangedListener(listener);
 
 // To remove listener for network quality event
-networkDiagnostics.removeOnNoNetworkChangedListener(listener);
+networkDiagnostics.removeOnNetworkUnreachableChangedListener(listener);
 
 // Quality Diagnostics
-DiagnosticsCallFeature diagnosticsCallFeature = call.feature(Features.DIAGNOSTICS_CALL);
+DiagnosticsCallFeature diagnosticsCallFeature = call.feature(Features.LOCAL_USER_DIAGNOSTICS);
 QualityDiagnosticChangedListener listener = (QualityDiagnosticChangedEvent args) -> {
   DiagnosticQuality diagnosticQuality = args.getValue();
   // Handle new value for network reconnect diagnostic.
 };
 
 NetworkDiagnostics networkDiagnostics = diagnosticsCallFeature.getNetworkDiagnostics();
-networkDiagnostics.addOnNetworkReconnectChangedListener(listener);
+networkDiagnostics.addOnNetworkReconnectionQualityChangedListener(listener);
 
 // To remove listener for media flag event
-networkDiagnostics.removeOnNetworkReconnectChangedListener(listener);
+networkDiagnostics.removeOnNetworkReconnectionQualityChangedListener(listener);
 
 /* MediaDiagnostic */
-DiagnosticsCallFeature diagnosticsCallFeature = call.feature(Features.DIAGNOSTICS_CALL);
+DiagnosticsCallFeature diagnosticsCallFeature = call.feature(Features.LOCAL_USER_DIAGNOSTICS);
 FlagDiagnosticChangedListener listener = (FlagDiagnosticChangedEvent args) -> {
   Boolean mediaValue = args.getValue();
   // Handle new value for speaker not functioning diagnostic.
 };
 
 MediaDiagnostics mediaDiagnostics = diagnosticsCallFeature.getMedia();
-mediaDiagnostics.addOnSpeakerNotFunctioningChangedListener(listener);
+mediaDiagnostics.addOnIsSpeakerNotFunctioningChangedListener(listener);
 
 // To remove listener for media flag event
-mediaDiagnostics.removeOnSpeakerNotFunctioningChangedListener(listener);
+mediaDiagnostics.removeOnIsSpeakerNotFunctioningChangedListener(listener);
 
 ```
 
@@ -72,15 +72,15 @@ mediaDiagnostics.removeOnSpeakerNotFunctioningChangedListener(listener);
 - Get the latest diagnostic values that were raised in current call. If we still didn't receive a value for the diagnostic, an exception is thrown.
 
 ```java
-DiagnosticsCallFeature diagnosticsCallFeature = call.feature(Features.DIAGNOSTICS_CALL);
+DiagnosticsCallFeature diagnosticsCallFeature = call.feature(Features.LOCAL_USER_DIAGNOSTICS);
 NetworkDiagnostics networkDiagnostics = diagnosticsCallFeature.getNetwork();
 MediaDiagnostics mediaDiagnostics = diagnosticsCallFeature.getMedia();
 
-NetworkDiagnosticValues latestNetwork = networkDiagnostics.getLatest();
-Boolean lastNetworkValue = latestNetwork.isNoNetwork(); // null if there isn't a value for this diagnostic.
+NetworkDiagnosticValues latestNetwork = networkDiagnostics.getLatestDiagnostics();
+Boolean lastNetworkValue = latestNetwork.isNetworkUnavailable(); // null if there isn't a value for this diagnostic.
 DiagnosticQuality lastReceiveQualityValue = latestNetwork.getNetworkReceiveQuality(); //  UNKNOWN if there isn't a value for this diagnostic.
 
-MediaDiagnosticValues latestMedia = networkDiagnostics.getLatest();
+MediaDiagnosticValues latestMedia = networkDiagnostics.getLatestDiagnostics();
 Boolean lastSpeakerNotFunctionValue = latestMedia.isSpeakerNotFunctioning(); // null if there isn't a value for this diagnostic.
 
 // Use the last values ...

articles/communication-services/concepts/voice-video-calling/includes/user-facing-diagnostics-ios.md

@@ -17,7 +17,7 @@ ms.subservice: calling
 User-facing diagnostics is an extended feature of the core `Call` API and allows you to diagnose an active call.
 
 ```swift
-let userFacingDiagnostics = self.call?.feature(Features.diagnostics)
+let userFacingDiagnostics = self.call?.feature(Features.localUserDiagnostics)
 ```
 
 ## User Facing Diagnostic events
@@ -27,117 +27,117 @@ let userFacingDiagnostics = self.call?.feature(Features.diagnostics)
 ```swift
 extension CallObserver: MediaDiagnosticsDelegate {
   func mediaDiagnostics(_ mediaDiagnostics: MediaDiagnostics,
-                        didChangeCameraFreezeValue args: FlagDiagnosticChangedEventArgs) {
+                        didChangeIsCameraFrozen args: DiagnosticFlagChangedEventArgs) {
     let newValue = args.value
     // Handle the diagnostic event value changed...
   }
 
   func mediaDiagnostics(_ mediaDiagnostics: MediaDiagnostics,
-                        didChangeSpeakerMutedValue args: FlagDiagnosticChangedEventArgs) {
+                        didChangeIsSpeakerMuted args: DiagnosticFlagChangedEventArgs) {
     let newValue = args.value
     // Handle the diagnostic event value changed...
   }
-
+    
   func mediaDiagnostics(_ mediaDiagnostics: MediaDiagnostics,
-                        didChangeCameraStartFailedValue args: FlagDiagnosticChangedEventArgs) {
+                        didChangeIsCameraStartFailed args: DiagnosticFlagChangedEventArgs) {
     let newValue = args.value
     // Handle the diagnostic event value changed...
   }
-  
+    
   func mediaDiagnostics(_ mediaDiagnostics: MediaDiagnostics,
-                        didChangeSpeakerNotFunctioningValue args: FlagDiagnosticChangedEventArgs) {
+                        didChangeIsSpeakerVolumeZero args: DiagnosticFlagChangedEventArgs) {
     let newValue = args.value
     // Handle the diagnostic event value changed...
   }
-  
+    
   func mediaDiagnostics(_ mediaDiagnostics: MediaDiagnostics,
-                        didChangeCameraPermissionDeniedValue args: FlagDiagnosticChangedEventArgs) {
+                        didChangeIsSpeakerNotFunctioning args: DiagnosticFlagChangedEventArgs) {
     let newValue = args.value
     // Handle the diagnostic event value changed...
   }
-  
+    
   func mediaDiagnostics(_ mediaDiagnostics: MediaDiagnostics,
-                        didChangeMicrophoneNotFunctioningValue args: FlagDiagnosticChangedEventArgs) {
+                        didChangeIsCameraPermissionDenied args: DiagnosticFlagChangedEventArgs) {
     let newValue = args.value
     // Handle the diagnostic event value changed...
   }
-
+    
   func mediaDiagnostics(_ mediaDiagnostics: MediaDiagnostics,
-                        didChangeMicrophoneMuteUnexpectedlyValue args: FlagDiagnosticChangedEventArgs) {
+                        didChangeIsMicrophoneNotFunctioning args: DiagnosticFlagChangedEventArgs) {
     let newValue = args.value
     // Handle the diagnostic event value changed...
   }
-
+    
   func mediaDiagnostics(_ mediaDiagnostics: MediaDiagnostics,
-                        didChangeCameraStartTimedOutValue args: FlagDiagnosticChangedEventArgs) {
+                        didChangeIsCameraStartTimedOut args: DiagnosticFlagChangedEventArgs) {
     let newValue = args.value
     // Handle the diagnostic event value changed...
   }
-  
+    
   func mediaDiagnostics(_ mediaDiagnostics: MediaDiagnostics,
-                        didChangeSpeakerVolumeIsZeroValue args: FlagDiagnosticChangedEventArgs) {
+                        didChangeIsMicrophoneMutedUnexpectedly args: DiagnosticFlagChangedEventArgs) {
     let newValue = args.value
     // Handle the diagnostic event value changed...
   }
-  
+    
   func mediaDiagnostics(_ mediaDiagnostics: MediaDiagnostics,
-                        didChangeNoSpeakerDevicesEnumeratedValue args: FlagDiagnosticChangedEventArgs) {
+                        didChangeIsZeroSpeakerDevicesAvailable args: DiagnosticFlagChangedEventArgs) {
     let newValue = args.value
-    // Handle the diagnostic event value changed...
+    // Handle the diagnostic event value changed...                            
   }
-  
+    
   func mediaDiagnostics(_ mediaDiagnostics: MediaDiagnostics,
-                        didChangeNoMicrophoneDevicesEnumeratedValue args: FlagDiagnosticChangedEventArgs) {
+                        didChangeIsZeroMicrophoneDevicesAvailable args: DiagnosticFlagChangedEventArgs) {
     let newValue = args.value
     // Handle the diagnostic event value changed...
   }
-  
+    
   func mediaDiagnostics(_ mediaDiagnostics: MediaDiagnostics,
-                        didChangeSpeakingWhileMicrophoneIsMutedValue args: FlagDiagnosticChangedEventArgs) {
+                        didChangeIsSpeakingWhileMicrophoneIsMuted args: DiagnosticFlagChangedEventArgs) {
     let newValue = args.value
     // Handle the diagnostic event value changed...
   }
-  
+    
   func mediaDiagnostics(_ mediaDiagnostics: MediaDiagnostics,
-                        didChangeSpeakerNotFunctioningDeviceInUseValue args: FlagDiagnosticChangedEventArgs) {
+                        didChangeIsSpeakerBusy args: DiagnosticFlagChangedEventArgs) {
     let newValue = args.value
     // Handle the diagnostic event value changed...
   }
-  
+    
   func mediaDiagnostics(_ mediaDiagnostics: MediaDiagnostics,
-                        didChangeMicrophoneNotFunctioningDeviceInUseValue args: FlagDiagnosticChangedEventArgs) {
+                        didChangeIsMicrophoneBusy args: DiagnosticFlagChangedEventArgs) {
     let newValue = args.value
     // Handle the diagnostic event value changed...
   }
 }
 
 extension CallObserver: NetworkDiagnosticsDelegate {
   func networkDiagnostics(_ networkDiagnostics: NetworkDiagnostics,
-                          didChangeNoNetworkValue args: FlagDiagnosticChangedEventArgs) {
+                          didChangeIsNetworkRelaysUnreachable args: DiagnosticFlagChangedEventArgs) {
     let newValue = args.value
     // Handle the diagnostic event value changed...
   }
-
+    
   func networkDiagnostics(_ networkDiagnostics: NetworkDiagnostics,
-                          didChangeNetworkReconnectValue args: QualityDiagnosticChangedEventArgs) {
+                          didChangeNetworkReconnectionQuality args: DiagnosticQualityChangedEventArgs) {
     let newValue = args.value
     // Handle the diagnostic event value changed...
   }
-
+    
   func networkDiagnostics(_ networkDiagnostics: NetworkDiagnostics,
-                          didChangeNetworkSendQualityValue args: QualityDiagnosticChangedEventArgs) {
+                          didChangeNetworkSendQuality args: DiagnosticQualityChangedEventArgs) {
     let newValue = args.value
     // Handle the diagnostic event value changed...
   }
-
+    
   func networkDiagnostics(_ networkDiagnostics: NetworkDiagnostics,
-                          didChangeNetworkReceiveQualityValue args: QualityDiagnosticChangedEventArgs) {
+                          didChangeIsNetworkUnavailable args: DiagnosticFlagChangedEventArgs) {
     let newValue = args.value
     // Handle the diagnostic event value changed...
   }
-
+    
   func networkDiagnostics(_ networkDiagnostics: NetworkDiagnostics,
-                          didChangeNetworkRelaysNotReachableValue args: FlagDiagnosticChangedEventArgs) {
+                          didChangeNetworkReceiveQuality args: DiagnosticQualityChangedEventArgs) {
     let newValue = args.value
     // Handle the diagnostic event value changed...
   }
@@ -153,13 +153,16 @@ self.mediaDiagnostics?.delegate = self.callObserver
 self.networkDiagnostics?.delegate = self.callObserver
 ```
 
+>[!NOTE]
+> If you have [`CallKit`](../../../how-tos/calling-sdk/callkit-integration.md) enabled via SDK or implement CallKit integration in your application, reporting mute state to CallKit can result in the OS making the application loose the hold to microphone due to privacy reasons which would cause the `didIsSpeakingWhileMicrophoneIsMuted` event not to work as expected because we cannot capture input from microphone device to detect that the user is speaking.
+
 ## Get the latest User Facing Diagnostics
 
 - Get the latest diagnostic values that were raised. If we still didn't receive a value for the diagnostic, `nil` or `.unknown` is returned.
 
 ```swift
-let lastSpeakerNotFunctionValue = self.mediaDiagnostics.latest.speakerNotFunctioning // Boolean?
-let lastNetworkRelayNotReachableValue = self.networkDiagnostics.latest.networkRelaysNotReachable // Boolean?
+let lastSpeakerNotFunctionValue = self.mediaDiagnostics.latest.isSpeakerNotFunctioning // Boolean?
+let lastNetworkRelayNotReachableValue = self.networkDiagnostics.latest.networkRelaysUnreachable // Boolean?
 let lastReceiveQualityValue = self.networkDiagnostics.latest.networkReceiveQuality // DiagnosticQuality (.good, .poor, .bad)
 // or .unknown if there isn't a diagnostic for this.
 ```

articles/communication-services/concepts/voice-video-calling/includes/user-facing-diagnostics-windows.md

@@ -17,15 +17,15 @@ ms.subservice: calling
 User-facing diagnostics is an extended feature of the core `Call` API and allows you to diagnose an active call.
 
 ```csharp
-this.diagnosticsCallFeature = call.Features.Diagnostics;
+this.diagnosticsCallFeature = call.Features.LocalUserDiagnostics;
 ```
 
 ## User Facing Diagnostic events
 
 - Implement listeners for diagnostic events.
 
 ```csharp
-private async void Call__OnNoNetworkChanged(object sender, FlagDiagnosticChangedEventArgs args)
+private async void Call__OnNetworkUnavailableChanged(object sender, FlagDiagnosticChangedEventArgs args)
 {
   var value = args.Value;
   // Handle the diagnostic event value changed...
@@ -45,19 +45,19 @@ private async void Call__OnMediaSpeakerNotFunctioningChanged(object sender, Flag
 - Set event methods for listening to events.
 
 ```csharp
-this.diagnosticsCallFeature = call.Features.Diagnostics;
+this.diagnosticsCallFeature = call.Features.LocalUserDiagnostics;
 this.networkDiagnostics = diagnosticsCallFeature.Network;
 this.mediaDiagnostics = diagnosticsCallFeature.Media;
 
-this.networkDiagnostics.NoNetworkChanged += Call__OnNoNetworkChanged;
+this.networkDiagnostics.NetworkUnavailableChanged += Call__OnNetworkUnavailableChanged;
 // Listen to other network events as well ... 
 
 this.mediaDiagnostics.SpeakerNotFunctioningChanged += Call__OnMediaSpeakerNotFunctioningChanged;
 // Listen to other media events as well ... 
 
 // Removing listeners
 
-this.networkDiagnostics.NoNetworkChanged -= Call__OnNoNetworkChanged;
+this.networkDiagnostics.NetworkUnavailable -= Call__NetworkUnavailableChanged;
 // Remove the other listeners as well ... 
 
 this.mediaDiagnostics.SpeakerNotFunctioningChanged -= Call__OnMediaSpeakerNotFunctioningChanged;
@@ -70,13 +70,13 @@ this.mediaDiagnostics.SpeakerNotFunctioningChanged -= Call__OnMediaSpeakerNotFun
 - Get the latest diagnostic values that were raised in current call. If we still didn't receive a value for the diagnostic, `null` or `.unknown` for is returned.
 
 ```csharp
-this.diagnosticsCallFeature = call.Features.Diagnostics;
+this.diagnosticsCallFeature = call.Features.LocalUserDiagnostics;
 this.networkDiagnostics = diagnosticsCallFeature.Network;
 this.mediaDiagnostics = diagnosticsCallFeature.Media;
 
-bool? lastSpeakerNotFunctionValue = this.mediaDiagnostics.GetLatest().IsSpeakerNotFunctioning; // Boolean?
-bool? lastNetworkRelayNotReachableValue = this.networkDiagnostics.GetLatest().IsNetworkRelaysNotReachable; // Boolean?
-DiagnosticQuality lastReceiveQualityValue = this.networkDiagnostics.GetLatest().NetworkReceiveQuality; // DiagnosticQuality (.good, .poor, .bad)
+bool? lastSpeakerNotFunctionValue = this.mediaDiagnostics.GetLatestDiagnostics().IsSpeakerNotFunctioning; // Boolean?
+bool? lastNetworkRelayNotReachableValue = this.networkDiagnostics.GetLatestDiagnostics().IsNetworkRelaysUnreachable; // Boolean?
+DiagnosticQuality lastReceiveQualityValue = this.networkDiagnostics.GetLatestDiagnostics().NetworkReceiveQuality; // DiagnosticQuality (.good, .poor, .bad)
 // or .unknown if there isn't a diagnostic for this.
 
 ```