Skip to content

Commit 45162f2

Browse files
committed
Add leave call conmfirmation documentation
1 parent ea44adc commit 45162f2

File tree

7 files changed

+109
-17
lines changed

7 files changed

+109
-17
lines changed

articles/communication-services/concepts/voice-video-calling/calling-sdk-features.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Azure Communication Services allows end-user browsers, apps, and services to dri
2121

2222
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).
2323

24-
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).
24+
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).
2525

2626
Once you start development, check out the [known issues page](../known-issues.md) to find bugs we're working on.
2727

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
### Disabling Leave Call Confirmation
2+
3+
To disable the leave 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`.
4+
5+
#### [Kotlin](#tab/kotlin)
6+
7+
```kotlin
8+
val callScreenOptions = CallCompositeCallScreenOptions(
9+
CallCompositeCallScreenControlBarOptions()
10+
.setLeaveCallConfirmation(CallCompositeLeaveCallConfirmationMode.ALWAYS_DISABLED)
11+
)
12+
13+
val callComposite: CallComposite =
14+
CallCompositeBuilder()
15+
.callScreenOptions(callScreenOptions)
16+
.build()
17+
```
18+
19+
#### [Java](#tab/java)
20+
21+
```java
22+
CallComposite callComposite =
23+
new CallCompositeBuilder()
24+
.callScreenOptions(new CallCompositeCallScreenOptions(
25+
new CallCompositeCallScreenControlBarOptions()
26+
.setLeaveCallConfirmation(CallCompositeLeaveCallConfirmationMode.ALWAYS_DISABLED)
27+
))
28+
.build();
29+
```
30+
31+
This setup ensures that the leave call confirmation prompt is disabled upon clicking the end call button.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
### Disabling Leave Call Confirmation
2+
3+
To disable the leave 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`.
4+
5+
```swift
6+
let callCompositeOptions = CallCompositeOptions(
7+
callScreenOptions: CallScreenOptions(
8+
controlBarOptions: CallScreenControlBarOptions(
9+
leaveCallConfirmationMode: LeaveCallConfirmationMode.alwaysDisabled
10+
)
11+
)
12+
)
13+
14+
let callComposite = CallComposite(withOptions: callCompositeOptions)
15+
```
16+
17+
This setup ensures that the leave call confirmation prompt is disabled when the end call button is clicked.
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: Disable the leave call confirmation prompt when clicking the end call button in the UI Library
3+
titleSuffix: An Azure Communication Services how-to guide
4+
description: Disable the leave call confirmation prompt in the Azure Communication Services UI Library.
5+
author: garchiro7
6+
ms.author: jorgegarc
7+
ms.service: azure-communication-services
8+
ms.subservice: calling
9+
ms.topic: how-to
10+
ms.date: 05/01/2024
11+
ms.custom: template-how-to
12+
zone_pivot_groups: acs-plat-ios-android
13+
14+
#Customer intent: As a developer, I want disable the leave call confirmation prompt when clicking the end call button in the UI Library.
15+
---
16+
17+
# Skip the setup screen in an application
18+
19+
The Azure Communication Services UI Library offers the option to disable the leave call confirmation prompt, by default the UI Library show a prompot asking the user to confirm the end of the call; one common customization might involve streamlining the user experience, such as disabling the leave call confirmation prompt when a user clicks the end call button. This adjustment can make the call termination process quicker and reduce friction for users who are accustomed to instant actions.
20+
21+
In this article, you learn how to disable the leave call confirmation prompt.
22+
23+
## Prerequisites
24+
25+
- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
26+
- A deployed Communication Services resource. [Create a Communication Services resource](../../quickstarts/create-communication-resource.md).
27+
- A user access token to enable the call client. [Get a user access token](../../quickstarts/access-tokens.md).
28+
- Optional: Completion of the [quickstart for getting started with the UI Library composites](../../quickstarts/ui-library/get-started-composites.md).
29+
30+
## Set up the feature
31+
32+
::: zone pivot="platform-android"
33+
[!INCLUDE [Disable the leave call confirmation prompt in the Android UI Library](./includes/leave-call-confirmation/android.md)]
34+
::: zone-end
35+
36+
::: zone pivot="platform-ios"
37+
[!INCLUDE [Disable the leave call confirmation prompt in the iOS UI Library](./includes/leave-call-confirmation/ios.md)]
38+
::: zone-end
39+
40+
## Next steps
41+
42+
- [Learn more about the UI Library](../../concepts/ui-library/ui-library-overview.md)

articles/communication-services/quickstarts/voice-video-calling/get-started-raw-media-access.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,6 @@ ms.custom: mode-other, devx-track-js
3939
For more information, see the following articles:
4040

4141
- Check out the [calling hero sample](../../samples/calling-hero-sample.md).
42-
- Get started with the [UI Library](https://aka.ms/acsstorybook).
42+
- Get started with the [UI Library](../../concepts/ui-library/ui-library-overview.md).
4343
- Learn about [Calling SDK capabilities](./getting-started-with-calling.md?pivots=platform-web).
4444
- Learn more about [how calling works](../../concepts/voice-video-calling/about-call-types.md).

articles/communication-services/quickstarts/voice-video-calling/get-started-video-effects.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,6 @@ ms.custom: mode-other, devx-track-js
3838
For more information, see the following articles:
3939

4040
- Check out our [calling hero sample](../../samples/calling-hero-sample.md)
41-
- Get started with the [UI Library](https://aka.ms/acsstorybook)
41+
- Get started with the [UI Library](../../concepts/ui-library/ui-library-overview.md)
4242
- Learn about [Calling SDK capabilities](./getting-started-with-calling.md?pivots=platform-web)
4343
- Learn more about [how calling works](../../concepts/voice-video-calling/about-call-types.md)

articles/communication-services/toc.yml

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -408,25 +408,27 @@ items:
408408
href: how-tos/calling-sdk/push-notifications.md
409409
- name: Using the mobile UI Library for voice and video
410410
items:
411-
- name: Set up localization
412-
href: how-tos/ui-library-sdk/localization.md
413-
- name: Set up theming
411+
- name: Configure default orientation
412+
href: how-tos/ui-library-sdk/orientation.md
413+
- name: Configure theming
414414
href: how-tos/ui-library-sdk/theming.md
415+
- name: Disable end call confirmation
416+
href: how-tos/ui-library-sdk/leave-call-confirmation.md
417+
- name: Enable audio only mode
418+
href: how-tos/ui-library-sdk/audio-only-mode.md
419+
- name: Enable picture-in-picture
420+
href: how-tos/ui-library-sdk/picture-in-picture.md
421+
- name: Enable skip the setup screen
422+
href: how-tos/ui-library-sdk/skip-setup-screen.md
415423
- name: Inject participant view data
416424
href: how-tos/ui-library-sdk/data-model.md
417-
- name: Skip the setup screen
418-
href: how-tos/ui-library-sdk/skip-setup-screen.md
419-
- name: Set up orientation
420-
href: how-tos/ui-library-sdk/orientation.md
421-
- name: Set up picture-in-picture
422-
href: how-tos/ui-library-sdk/picture-in-picture.md
423-
- name: Set up CallKit
425+
- name: Integrate CalllKit
424426
href: how-tos/ui-library-sdk/callkit.md
425-
- name: Set up one-to-one calling and push notifications
427+
- name: Set up localization
428+
href: how-tos/ui-library-sdk/localization.md
429+
- name: Set up up one-to-one calling and push notifications
426430
href: how-tos/ui-library-sdk/one-to-one-calling.md
427-
- name: Audio Only Mode
428-
href: how-tos/ui-library-sdk/audio-only-mode.md
429-
- name: Troubleshoot
431+
- name: Troubleshooting
430432
href: how-tos/ui-library-sdk/troubleshooting.md
431433
- name: Events
432434
items:

0 commit comments

Comments
 (0)