Merge pull request #273341 from garchiro7/origin/leave-call-confirmation

ttorble · web-flow · commit 74fb7aa316c8 · 2024-06-04T08:55:34.000+01:00
Add leave call confirmation customization documentation
diff --git a/articles/communication-services/concepts/ui-library/includes/mobile-ui-use-cases.md b/articles/communication-services/concepts/ui-library/includes/mobile-ui-use-cases.md
@@ -28,6 +28,7 @@ You can use the call composite in Communication Services to create these use cas
 |                                                                                                 | Manage the camera device                               |
 |                                                                                                 | Manage the speaker device (wired or Bluetooth)                              |
 |                                                                                                 | Make local preview available for a user to check video       |
+|                                                                                                 | Enable end call confirmation dialogue                 |
 | Call controls                                                                            | Mute and unmute a call                                       |
 |                                                                                                 | Turn video on or off during a call                                   |
 |                                                                                                 | End a call                                               |
@@ -79,24 +80,33 @@ Use the UI Library for mobile native platforms to give local and remote particip
 
 ### Skip Setup Screen
 
-UI Library provides the capability to join a call skipping the setup screen of the call join experience. By default, user goes through a setup screen to join a call. Here, user sets the call configuration such as camera turn on or off, microphone turn on or off and audio device selection before joining a call. This screen requires user interaction to join a call, which might be unnecessary for some users. So we provide the capability to join a call by skipping the setup screen and providing the call configuration APIs. For more information, see [How to use Skip Setup Screen Feature](../../../how-tos/ui-library-sdk/skip-setup-screen.md)
+UI Library provides the capability to join a call skipping the setup screen of the call join experience. By default, user goes through a setup screen to join a call. Here, user sets the call configuration such as camera turn on or off, microphone turn on or off and audio device selection before joining a call. This screen requires user interaction to join a call, which might be unnecessary for some users. So we provide the capability to join a call by skipping the setup screen and providing the call configuration APIs. For more information, see [How to use Skip Setup Screen Feature.](../../../how-tos/ui-library-sdk/skip-setup-screen.md)
 
 ### Audio Only Mode
 
-The Audio Only Mode in the UI Library allows participants to join calls using only their audio, without sharing or receiving video. This feature is used to conserve bandwidth and maximize privacy. When activated, the Audio Only Mode automatically disables the video functionalities for both sending and receiving streams, and adjusts the UI to reflect this change by removing video-related controls. This mode can be enabled through the CallComposite configuration, more information available through the [Audio Only Quick Start](../../../how-tos/ui-library-sdk/audio-only-mode.md)
+The Audio Only Mode in the UI Library allows participants to join calls using only their audio, without sharing or receiving video. This feature is used to conserve bandwidth and maximize privacy. When activated, the Audio Only Mode automatically disables the video functionalities for both sending and receiving streams, and adjusts the UI to reflect this change by removing video-related controls. This mode can be enabled through the CallComposite configuration, more information available through the [Audio Only Quick Start.](../../../how-tos/ui-library-sdk/audio-only-mode.md)
 
 ### Orientation
 
-UI Library supports screen orientation setup for each of the screen separately prior to launch the library experience. This allows application developers to set up a fixed orientation for the calling experience which would align their application orientation. To learn more about the list of supported orientation for both Android and iOS platform and usage of the API, see [How to use Orientation Feature](../../../how-tos/ui-library-sdk/orientation.md)
+UI Library supports screen orientation setup for each of the screen separately prior to launch the library experience. This allows application developers to set up a fixed orientation for the calling experience, which would align their application orientation. To learn more about the list of supported orientation for both Android and iOS platform and usage of the API, see [How to use Orientation Feature.](../../../how-tos/ui-library-sdk/orientation.md)
 
 ### Multitasking and Picture-in-Picture
-UI Library supports picture in picture mode for call screen. While being in the call, user can click back button on call screen to enable multitasking which will take user back to previous screen. If Picture-in-Picture is enabled, a system Picture-in-Picture will be displayed for call. To learn more about the multitasking and Picture-in-Picture for both Android and iOS platform and usage of the API, see [How to use Picture-in-Picture](../../../how-tos/ui-library-sdk/picture-in-picture.md)
+
+UI Library supports picture in picture mode for call screen. While being in the call, user can click back button on call screen to enable multitasking, which will take user back to previous screen. If Picture-in-Picture is enabled, a system Picture-in-Picture will be displayed for call. To learn more about the multitasking and Picture-in-Picture for both Android and iOS platform and usage of the API, see [How to use Picture-in-Picture.](../../../how-tos/ui-library-sdk/picture-in-picture.md)
 
 ### CallKit support
-UI Library supports CallKit Integration to handle interaction with CallKit for calls. To learn more about the integration for iOS platform and usage of the API, see [How to use CallKit](../../../how-tos/ui-library-sdk/callkit.md)
+
+UI Library supports CallKit Integration to handle interaction with CallKit for calls. To learn more about the integration for iOS platform and usage of the API, see [How to use CallKit.](../../../how-tos/ui-library-sdk/callkit.md)
 
 ### One-to-one call and PUSH notification support
-UI Library supports one-to-one VoIP call to dial users by communication identifier. To receive incoming call UI Library also supports registering for PUSH notifications. To learn more about the integration for Android and iOS platform and usage of the API, see [How to make one-to-one call and receive PUSH notifications](../../../how-tos/ui-library-sdk/one-to-one-calling.md)
+
+UI Library supports one-to-one VoIP call to dial users by communication identifier. To receive incoming call UI Library also supports registering for PUSH notifications. To learn more about the integration for Android and iOS platform and usage of the API, see [How to make one-to-one call and receive PUSH notifications.](../../../how-tos/ui-library-sdk/one-to-one-calling.md)
+
+### Disable end call prompt
+
+When developing applications that integrate calling capabilities, ensuring a seamless and intuitive user experience is crucial. One area where UX can be streamlined is during the call termination process. Specifically, developers might find it beneficial to disable the left call confirmation prompt that appears when a user want to end call. This feature, while useful in preventing accidental call terminations, can sometimes hinder the user experience, especially in environments where speed and efficiency are crucial. [How to disable the call confirmation](../../../how-tos/ui-library-sdk/leave-call-confirmation.md)
+
+Fast-Paced Communication Environments: In settings such as trading floors, emergency call centers, or customer service centers where decisions and actions must be executed rapidly, the additional step of confirming call termination can impede workflow efficiency.
 
 ## Chat use cases
 
diff --git a/articles/communication-services/concepts/voice-video-calling/calling-sdk-features.md b/articles/communication-services/concepts/voice-video-calling/calling-sdk-features.md
@@ -21,7 +21,7 @@ Azure Communication Services allows end-user browsers, apps, and services to dri
 
 To build your own user experience with the Calling SDK, check out [Calling quickstarts](../../quickstarts/voice-video-calling/getting-started-with-calling.md) or [Calling hero sample](../../samples/calling-hero-sample.md).
 
-If you'd like help with the end-user experience, the Azure Communication Services UI Library provides a collection of open-source production-ready UI components to drop into your application. With this set of prebuilt controls, you can create beautiful communication experiences using [Microsoft's Fluent design language](https://developer.microsoft.com/en-us/fluentui#/). If you want to learn more about the UI Library, visit [the overview site](../ui-library/ui-library-overview.md) or [Storybook](https://aka.ms/acsstorybook).
+If you'd like help with the end-user experience, the Azure Communication Services UI Library provides a collection of open-source production-ready UI components to drop into your application. With this set of prebuilt controls, you can create beautiful communication experiences using [Microsoft's Fluent design language](https://developer.microsoft.com/en-us/fluentui#/). If you want to learn more about the UI Library, visit [the overview site](../ui-library/ui-library-overview.md).
 
 Once you start development, check out the [known issues page](../known-issues.md) to find bugs we're working on.
 
@@ -99,7 +99,7 @@ The following list presents the set of features that are currently available in
 |                   | Custom background image                                                                                             | ✔️   | ✔️       | ✔️              | ✔️                 |
 | [Audio Effects](../../tutorials/audio-quality-enhancements/add-noise-supression.md)       | [Music Mode](./music-mode.md)          | ❌   | ✔️       | ✔️              | ✔️                 |
 |      | Echo cancellation        | ❌   | ✔️       | ✔️              | ✔️                 |
-|      | Noise supression          | ✔️   | ✔️       | ✔️              | ✔️                 |
+|      | Noise suppression          | ✔️   | ✔️       | ✔️              | ✔️                 |
 |      | Automatic gain control (AGC)        | ❌   | ✔️       | ✔️              | ✔️                 |
 | Notifications <sup>4</sup>    | [Push notifications](../../how-tos/calling-sdk/push-notifications.md)          | ✔️  | ✔️       | ✔️              | ✔️                 |
 
diff --git a/articles/communication-services/how-tos/ui-library-sdk/includes/leave-call-confirmation/android.md b/articles/communication-services/how-tos/ui-library-sdk/includes/leave-call-confirmation/android.md
@@ -0,0 +1,41 @@
+---
+description: Learn how to use the Calling composite on Android to customize the leave call confirmation API
+author: garchiro7
+
+ms.author: jorgegarc
+ms.date: 05/01/2024
+ms.topic: include
+ms.service: azure-communication-services
+---
+
+### Disabling Leave Call Confirmation
+
+To disable the left call confirmation prompt when clicking the end call button, utilize `CallCompositeCallScreenOptions` to configure `CallCompositeCallScreenControlBarOptions`. Set `CallCompositeLeaveCallConfirmationMode.ALWAYS_DISABLED` as the constructor parameter. By default, the UI library employs `CallCompositeLeaveCallConfirmationMode.ALWAYS_ENABLED`.
+
+#### [Kotlin](#tab/kotlin)
+
+```kotlin
+val callScreenOptions = CallCompositeCallScreenOptions(
+            CallCompositeCallScreenControlBarOptions()
+                .setLeaveCallConfirmation(CallCompositeLeaveCallConfirmationMode.ALWAYS_DISABLED)
+        )
+
+val callComposite: CallComposite =
+            CallCompositeBuilder()
+            .callScreenOptions(callScreenOptions)
+            .build()
+```
+
+#### [Java](#tab/java)
+
+```java
+CallComposite callComposite = 
+    new CallCompositeBuilder()
+        .callScreenOptions(new CallCompositeCallScreenOptions(
+            new CallCompositeCallScreenControlBarOptions()
+                .setLeaveCallConfirmation(CallCompositeLeaveCallConfirmationMode.ALWAYS_DISABLED)
+        ))
+        .build();
+```
+
+This setup ensures that the left call confirmation prompt is disabled upon clicking the end call button.
diff --git a/articles/communication-services/how-tos/ui-library-sdk/includes/leave-call-confirmation/ios.md b/articles/communication-services/how-tos/ui-library-sdk/includes/leave-call-confirmation/ios.md
@@ -0,0 +1,27 @@
+---
+description: Learn how to use the Calling composite on iOS to customize the leave call confirmation API
+author: garchiro7
+
+ms.author: jorgegarc
+ms.date: 05/01/2024
+ms.topic: include
+ms.service: azure-communication-services
+---
+
+### Disabling Leave Call Confirmation
+
+To disable the left call confirmation prompt triggered by clicking the end call button, utilize the `CallScreenOptions` class to configure the `CallScreenControlBarOptions`. Set the `LeaveCallConfirmationMode` parameter to `alwaysDisabled`. By default, the UI library enables `LeaveCallConfirmationMode` as `alwaysEnabled`.
+
+```swift
+let callCompositeOptions = CallCompositeOptions(
+    callScreenOptions: CallScreenOptions(
+        controlBarOptions: CallScreenControlBarOptions(
+            leaveCallConfirmationMode: LeaveCallConfirmationMode.alwaysDisabled
+        )
+    )
+)
+
+let callComposite = CallComposite(withOptions: callCompositeOptions)
+```
+
+This setup ensures that the left call confirmation prompt is disabled when the end call button is clicked.
diff --git a/articles/communication-services/how-tos/ui-library-sdk/leave-call-confirmation.md b/articles/communication-services/how-tos/ui-library-sdk/leave-call-confirmation.md
@@ -0,0 +1,42 @@
+---
+title: Disable the left call confirmation prompt when clicking the end call button in the UI Library
+titleSuffix: An Azure Communication Services how-to guide
+description: Disable the left call confirmation prompt in the Azure Communication Services UI Library.
+author: garchiro7
+ms.author: jorgegarc
+ms.service: azure-communication-services
+ms.subservice: calling
+ms.topic: how-to 
+ms.date: 05/01/2024
+ms.custom: template-how-to
+zone_pivot_groups: acs-plat-ios-android
+
+#Customer intent: As a developer, I want disable the leave call confirmation prompt when clicking the end call button in the UI Library.
+---
+
+# Disable the call confirmation prompt in an application
+
+The Azure Communication Services UI Library offers the option to disable the left call confirmation prompt, by default the UI Library show a prompt asking the user to confirm the end of the call; one common customization might involve streamlining the user experience, such as disabling the left call confirmation prompt when a user decide to end the call. This adjustment can make the call termination process quicker and reduce friction for users who are accustomed to instant actions.
+
+In this article, you learn how to disable the left call confirmation prompt.
+
+## Prerequisites
+
+- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
+- A deployed Communication Services resource. [Create a Communication Services resource](../../quickstarts/create-communication-resource.md).
+- A user access token to enable the call client. [Get a user access token](../../quickstarts/access-tokens.md).
+- Optional: Completion of the [quickstart for getting started with the UI Library composites](../../quickstarts/ui-library/get-started-composites.md).
+
+## Set up the feature
+
+::: zone pivot="platform-android"
+[!INCLUDE [Disable the leave call confirmation prompt in the Android UI Library](./includes/leave-call-confirmation/android.md)]
+::: zone-end
+
+::: zone pivot="platform-ios"
+[!INCLUDE [Disable the leave call confirmation prompt in the iOS UI Library](./includes/leave-call-confirmation/ios.md)]
+::: zone-end
+
+## Next steps
+
+- [Learn more about the UI Library](../../concepts/ui-library/ui-library-overview.md)
diff --git a/articles/communication-services/quickstarts/voice-video-calling/get-started-raw-media-access.md b/articles/communication-services/quickstarts/voice-video-calling/get-started-raw-media-access.md
@@ -39,6 +39,6 @@ ms.custom: mode-other, devx-track-js
 For more information, see the following articles:
 
 - Check out the [calling hero sample](../../samples/calling-hero-sample.md).
-- Get started with the [UI Library](https://aka.ms/acsstorybook).
+- Get started with the [UI Library](../../concepts/ui-library/ui-library-overview.md).
 - Learn about [Calling SDK capabilities](./getting-started-with-calling.md?pivots=platform-web).
 - Learn more about [how calling works](../../concepts/voice-video-calling/about-call-types.md).
diff --git a/articles/communication-services/quickstarts/voice-video-calling/get-started-video-effects.md b/articles/communication-services/quickstarts/voice-video-calling/get-started-video-effects.md
@@ -38,6 +38,6 @@ ms.custom: mode-other, devx-track-js
 For more information, see the following articles:
 
 - Check out our [calling hero sample](../../samples/calling-hero-sample.md)
-- Get started with the [UI Library](https://aka.ms/acsstorybook)
+- Get started with the [UI Library](../../concepts/ui-library/ui-library-overview.md)
 - Learn about [Calling SDK capabilities](./getting-started-with-calling.md?pivots=platform-web)
 - Learn more about [how calling works](../../concepts/voice-video-calling/about-call-types.md) 
diff --git a/articles/communication-services/toc.yml b/articles/communication-services/toc.yml
@@ -414,25 +414,27 @@ items:
         href: how-tos/calling-sdk/push-notifications.md
       - name: Using the mobile UI Library for voice and video
         items: 
-        - name: Set up localization
-          href: how-tos/ui-library-sdk/localization.md
-        - name: Set up theming
+        - name: Configure default orientation
+          href: how-tos/ui-library-sdk/orientation.md
+        - name: Configure theming
           href: how-tos/ui-library-sdk/theming.md
+        - name: Disable end call confirmation
+          href: how-tos/ui-library-sdk/leave-call-confirmation.md
+        - name: Enable audio only mode
+          href: how-tos/ui-library-sdk/audio-only-mode.md
+        - name: Enable picture-in-picture
+          href: how-tos/ui-library-sdk/picture-in-picture.md
+        - name: Enable skip the setup screen
+          href: how-tos/ui-library-sdk/skip-setup-screen.md
         - name: Inject participant view data
           href: how-tos/ui-library-sdk/data-model.md
-        - name: Skip the setup screen
-          href: how-tos/ui-library-sdk/skip-setup-screen.md
-        - name: Set up orientation
-          href: how-tos/ui-library-sdk/orientation.md
-        - name: Set up picture-in-picture
-          href: how-tos/ui-library-sdk/picture-in-picture.md
-        - name: Set up CallKit
+        - name: Integrate CalllKit
           href: how-tos/ui-library-sdk/callkit.md
-        - name: Set up one-to-one calling and push notifications
+        - name: Set up localization
+          href: how-tos/ui-library-sdk/localization.md
+        - name: Set up up one-to-one calling and push notifications
           href: how-tos/ui-library-sdk/one-to-one-calling.md
-        - name: Audio Only Mode
-          href: how-tos/ui-library-sdk/audio-only-mode.md
-        - name: Troubleshoot
+        - name: Troubleshooting
           href: how-tos/ui-library-sdk/troubleshooting.md
     - name: Events
       items:
