Skip to content

Commit 326755a

Browse files
v-regandownerv-regandowner
authored
Merge pull request #219497 from pavelprystinka/calling_troubleshooting
Calling troubleshooting
2 parents f1b642a + 5a11676 commit 326755a

File tree

5 files changed

+110
-0
lines changed

5 files changed

+110
-0
lines changed

‎articles/communication-services/concepts/ui-library/includes/mobile-ui-use-cases.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,8 @@ When troubleshooting happens for voice or video calls, you may be asked to provi
111111

112112
This CallID can be retrieved via the action bar on the bottom of the call screen; you'll see an ellipsis button; once the user performs the tap action an option of ***"Share diagnostics info"***; the user will have the capability to share **the diagnostics info** that will be required to track any issues by the support team.
113113

114+
For programmatic access to **CallID**, see ["How to get debug information programmatically"](../../../how-tos/ui-library-sdk/troubleshooting.md).
115+
114116
You can learn more about troubleshooting guidelines here: ["Troubleshooting in Azure Communication Services"](../../troubleshooting-info.md) page.
115117

116118
| Calling screen | Diagnostic info menu | Share CallID |

‎articles/communication-services/how-tos/ui-library-sdk/includes/troubleshooting/android.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
description: In this tutorial, you learn how to retrieve CallComposite debug information
3+
author: pprystinka
4+
5+
ms.date: 11/23/2022
6+
ms.topic: include
7+
ms.service: azure-communication-services
8+
---
9+
10+
Azure Communication UI [open source library](https://github.com/Azure/communication-ui-library-android) for Android and the sample application code can be found [here](https://github.com/Azure-Samples/communication-services-android-quickstarts/tree/main/ui-library-quick-start)
11+
12+
### Get debug information
13+
14+
When troubleshooting happens for voice or video calls, user may be asked to provide a CallID; this ID is used to identify Communication Services calls.
15+
16+
CallID can be retrieved from `CallComposite`:
17+
18+
#### [Kotlin](#tab/kotlin)
19+
20+
```kotlin
21+
val callComposite: CallComposite = CallCompositeBuilder().build()
22+
...
23+
val debugInfo = callComposite.debugInfo
24+
val lastCallId = debugInfo.lastCallId
25+
```
26+
27+
#### [Java](#tab/java)
28+
29+
```java
30+
CallComposite callComposite = new CallCompositeBuilder().build();
31+
...
32+
CallCompositeDebugInfo debugInfo = callComposite.getDebugInfo();
33+
String lastCallId = debugInfo.getLastCallId();
34+
```

‎articles/communication-services/how-tos/ui-library-sdk/includes/troubleshooting/ios.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
description: In this tutorial, you learn how to retrieve CallComposite debug information
3+
author: pprystinka
4+
5+
ms.date: 11/23/2022
6+
ms.topic: include
7+
ms.service: azure-communication-services
8+
---
9+
10+
Azure Communication UI [open source library](https://github.com/Azure/communication-ui-library-ios) for iOS and the sample application code can be found [here](https://github.com/Azure-Samples/communication-services-ios-quickstarts/tree/main/ui-library-quick-start)
11+
12+
### Debug information
13+
14+
`DebugInfo` is an object that contains debug information for the current CallComposite object.
15+
16+
Call ID is used to identify Communication Services calls. `lastCallId` is an ID of the last call for the current CallComposite object. When a CallComposite object is created and a call isn't started yet, `lastCallId` will return `nil` value. The call ID value will be set when a call is started. The value will be preserved until a new call is started or CallComposite instance is deallocated.
17+
18+
The debug information can be retrieved from `CallComposite`:
19+
20+
```swift
21+
let callComposite = CallComposite()
22+
...
23+
let debugInfo = callComposite.debugInfo
24+
let lastCallId = debugInfo.lastCallId
25+
```

‎articles/communication-services/how-tos/ui-library-sdk/troubleshooting.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: Troubleshooting over the UI Library
3+
titleSuffix: An Azure Communication Services how-to guide
4+
description: Use Azure Communication Services UI Library for Mobile native to get debug information.
5+
author: pavelprystinka
6+
ms.author: pprystinka
7+
ms.service: azure-communication-services
8+
ms.topic: how-to
9+
ms.custom: template-how-to
10+
ms.date: 11/23/2022
11+
zone_pivot_groups: acs-plat-web-ios-android
12+
13+
#Customer intent: As a developer, I want to get debug information for troubleshooting
14+
---
15+
16+
# Troubleshooting over the Calling UI Library
17+
18+
When troubleshooting happens for voice or video calls, you may be asked to provide a CallID; this ID is used to identify Communication Services calls.
19+
20+
## Prerequisites
21+
22+
- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
23+
- A deployed Communication Services resource. [Create a Communication Services resource](../../quickstarts/create-communication-resource.md).
24+
- A `User Access Token` to enable the call client. For more information on [how to get a `User Access Token`](../../quickstarts/access-tokens.md)
25+
- Optional: Complete the quickstart for [getting started with the UI Library composites](../../quickstarts/ui-library/get-started-composites.md)
26+
27+
::: zone pivot="platform-web"
28+
> [!NOTE]
29+
> For detailed documentation and quickstarts about the Web UI Library visit the [**Web UI Library Storybook**](https://azure.github.io/communication-ui-library).
30+
### You can access the following link to learn more
31+
- [Troubleshooting](https://azure.github.io/communication-ui-library/?path=/docs/troubleshooting--page)
32+
::: zone-end
33+
34+
::: zone pivot="platform-android"
35+
[!INCLUDE [Troubloshooting Android UI library](./includes/troubleshooting/android.md)]
36+
::: zone-end
37+
38+
::: zone pivot="platform-ios"
39+
[!INCLUDE [Troubloshooting over the iOS UI library](./includes/troubleshooting/ios.md)]
40+
::: zone-end
41+
42+
User may find Call ID via the action bar on the bottom of the call screen. See more [Troubleshooting guide](../../concepts/ui-library/ui-library-use-cases.md?branch=pr-en-us-217148&pivots=platform-mobile#troubleshooting-guide)
43+
44+
## Next steps
45+
46+
- [Learn more about UI Library](../../concepts/ui-library/ui-library-overview.md)
47+
- [Learn more about UI Library Design Kit](../../quickstarts/ui-library/get-started-ui-kit.md)

‎articles/communication-services/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -409,6 +409,8 @@ items:
409409
href: how-tos/ui-library-sdk/theming.md
410410
- name: Participant View Data Injection
411411
href: how-tos/ui-library-sdk/data-model.md
412+
- name: Troubleshooting
413+
href: how-tos/ui-library-sdk/troubleshooting.md
412414
- name: Using the Call Automation library
413415
items:
414416
- name: Control and steer calls

0 commit comments

Comments
 (0)