Skip to content

Commit d5e0ca8

Browse files
authored
Merge pull request #262710 from ahammer/docs-editor/collecting-user-feedback-1704747938
Create article collecting-user-feedback
2 parents 35c0c28 + bed8ee9 commit d5e0ca8

File tree

15 files changed

+829
-84
lines changed

15 files changed

+829
-84
lines changed

articles/communication-services/concepts/troubleshooting-info.md

Lines changed: 21 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This document helps you troubleshoot issues that you may experience within your
1717

1818
## Getting help
1919

20-
We encourage developers to submit questions, suggest features, and report problems as issues. To aid in doing this, we have a [dedicated support and help options page](../support.md) which lists your options for support.
20+
We encourage developers to submit questions, suggest features, and report problems as issues. To aid in getting help, we have a [dedicated support and help options page](../support.md) that lists your options for support.
2121

2222
To help you troubleshoot certain types of issues, you may be asked for any of the following pieces of information:
2323

@@ -83,7 +83,7 @@ When troubleshooting issues with the Call Automation SDK, like call management o
8383
- From the header of API response, locate the field `X-Ms-Skype-Chain-Id`.
8484

8585
![Screenshot of response header showing X-Ms-Skype-Chain-Id.](media/troubleshooting/response-header.png)
86-
- From the callback events your application receives after executing an action e.g. `CallConnected` or `PlayFailed`, locate the correlationID.
86+
- From the callback events your application receives after executing an action. For example `CallConnected` or `PlayFailed`, locate the correlationID.
8787

8888
![Screenshot of call disconnected event showing correlation ID.](media/troubleshooting/correlation-id-in-callback-event.png)
8989

@@ -166,16 +166,11 @@ Console.WriteLine($"Email operation id = {emailSendOperation.Id}");
166166

167167
## Accessing Support Files in the Calling SDK
168168

169-
[!INCLUDE [Public Preview](../includes/public-preview-include.md)]
169+
Calling SDK provides convenience methods to get access to the Log Files. These files can serve valuable to Microsoft support specialists and engineers. Pro-actively collecting these logs when issues are detected is recommended.
170170

171-
Calling SDK provides convenience methods to get access to the Log Files. To actively collect, it is encouraged to pair this functionality with your applications support tooling.
171+
## Enable and Access Call Logs
172172

173-
[Log File Access Conceptual Document](../concepts/voice-video-calling/retrieve-support-files.md)
174-
[Log File Access Tutorials](../tutorials/log-file-retrieval-tutorial.md)
175-
176-
## Enable and access call logs
177-
178-
# [JavaScript](#tab/javascript)
173+
### [JavaScript]
179174

180175
The Azure Communication Services Calling SDK relies internally on [@azure/logger](https://www.npmjs.com/package/@azure/logger) library to control logging.
181176
Use the `setLogLevel` method from the `@azure/logger` package to configure the log output level. Create a logger and pass it into the CallClient constructor:
@@ -198,35 +193,25 @@ AzureLogger.log = (...args) => {
198193
};
199194
```
200195

201-
# [iOS](#tab/ios)
202-
203-
In an iOS Application, logs are stored in `.blog` files. Note that you can't view the logs directly because they're encrypted.
196+
### Native SDK (Android/iOS)
204197

205-
These can be accessed by opening Xcode. Go to Windows > Devices and Simulators > Devices. Select your device. Under Installed Apps, select your application and click on "Download container".
198+
For Android, iOS and Windows the Azure Communication Services Calling SDK offers access to log files.
206199

207-
This process gives you a `xcappdata` file. Right-click on this file and select “Show package contents”. You'll then see the `.blog` files that you can then attach to your Azure support request.
200+
For Calling Native SDK's, refer to [the log file access tutorials](../tutorials/log-file-retrieval-tutorial.md)
208201

209-
# [Android](#tab/android)
210-
211-
In an Android application, logs are stored in `.blog` files. Note that you can't view the logs directly because they're encrypted.
202+
### UI Libraries (Android, iOS)
212203

213-
On Android Studio, navigate to the Device File Explorer by selecting View > Tool Windows > Device File Explorer from both the simulator and the device. The `.blog` file is located within your application's directory, which should look something like `/data/data/[app_name_space:com.contoso.com.acsquickstartapp]/files/acs_sdk.blog`. You can attach this file to your support request.
204+
If you are using the Azure Communication Services UI Libraries for Android or iOS, user feedback can be solicited through the built-in support form.
214205

215-
---
206+
For more information on how to use the support functionality of the Calling UI Support form, see the [Support Form integration tutorial](../tutorials/collecting-user-feedback/collecting-user-feedback.md). This document guides you through adding the necessary event handler, and creating a basic client/server implementation for centralized storage of support information. This guide is designed to guide you on your path towards an integration with the support services your organization uses.
216207

217-
## Enable and access call logs (Windows)
208+
## Building end to end Support Flows in your ACS Integrations
218209

219-
In a Windows application, logs are stored in `.blog` files. Note that you can't view the logs directly because they're encrypted.
220-
221-
These are accessed by looking at where your app is keeping its local data. There are many ways to figure out where a UWP app keeps its local data, the following steps are just one of these ways:
222-
1. Open a Windows Command Prompt (Windows Key + R)
223-
2. Type `cmd.exe`
224-
3. Type `where /r %USERPROFILE%\AppData acs*.blog`
225-
4. Please check if the app ID of your application matches with the one returned by the previous command.
226-
5. Open the folder with the logs by typing `start ` followed by the path returned by the step 3. For example: `start C:\Users\myuser\AppData\Local\Packages\e84000dd-df04-4bbc-bf22-64b8351a9cd9_k2q8b5fxpmbf6`
227-
6. Please attach all the `*.blog` and `*.etl` files to your Azure support request.
210+
Whether you are using Calling SDK or Calling UI SDK, providing support to end users is a key component of any robust integration. The following document highlights the key considerations at each point of the Support feedback loop, and provides jumping off points to learn more.
228211

212+
[Providing User Support](../concepts/voice-video-calling/retrieve-support-files.md)
229213

214+
---
230215
<a name='finding-azure-active-directory-information'></a>
231216

232217
## Finding Microsoft Entra information
@@ -236,7 +221,7 @@ These are accessed by looking at where your app is keeping its local data. There
236221
* **Getting User ID**
237222

238223
## Getting Directory ID
239-
To find your Directory (tenant) ID, follow the steps listed below:
224+
To find your Directory (tenant) ID, follow these steps:
240225

241226
1. Navigate to [Azure portal](https://portal.azure.com) and sign in to the Azure portal using the credentials.
242227
1. From the left-pane, select Microsoft Entra ID.
@@ -245,7 +230,7 @@ To find your Directory (tenant) ID, follow the steps listed below:
245230
![Screenshot of how to copy Microsoft Entra tenant ID and store it.](./media/troubleshooting/copy-aad-directory-id.png)
246231

247232
## Getting Application ID
248-
To find your Application ID, follow the steps listed below:
233+
To find your Application ID, follow these steps:
249234

250235
1. Navigate to [Azure portal](https://portal.azure.com) and sign in to the Azure portal using the credentials.
251236
1. From the left-pane, select Microsoft Entra ID.
@@ -257,7 +242,7 @@ To find your Application ID, follow the steps listed below:
257242
The directory (tenant) ID can also be found in the application overview page.
258243

259244
## Getting User ID
260-
To find your User ID, follow the steps listed below:
245+
To find your User ID, follow these steps:
261246

262247
1. Navigate to [Azure portal](https://portal.azure.com) and sign in to the Azure portal using the credentials.
263248
1. From the left-pane, select Microsoft Entra ID.
@@ -267,7 +252,7 @@ To find your User ID, follow the steps listed below:
267252
![Screenshot of how to copy Microsoft Entra user ID and store it.](./media/troubleshooting/copy-aad-user-id.png)
268253

269254
## Getting immutable resource ID
270-
Sometimes you also need to provide immutable resource ID of your Communication Service resource. To find it, follow the steps listed below:
255+
Sometimes you also need to provide immutable resource ID of your Communication Service resource. To find it, follow these steps:
271256

272257
1. Navigate to [Azure portal](https://portal.azure.com) and sign in to the Azure portal using the credentials.
273258
1. Open your Communication Service resource.
@@ -284,14 +269,14 @@ There are two ways to verify your Teams License eligibility to use Azure Communi
284269
* **Checking your current Teams license via Microsoft Graph API**
285270

286271
#### Verification via Teams web client
287-
To verify your Teams License eligibility via Teams web client, follow the steps listed below:
272+
To verify your Teams License eligibility via Teams web client, follow these steps:
288273

289274
1. Open your browser and navigate to [Teams web client](https://teams.microsoft.com/).
290275
1. Sign in with credentials that have a valid Teams license.
291276
1. If the authentication is successful and you remain in the https://teams.microsoft.com/ domain, then your Teams License is eligible. If authentication fails or you're redirected to the https://teams.live.com/v2/ domain, then your Teams License isn't eligible to use Azure Communication Services support for Teams users.
292277

293278
#### Checking your current Teams license via Microsoft Graph API
294-
You can find your current Teams license using [licenseDetails](/graph/api/resources/licensedetails) Microsoft Graph API that returns the licenses assigned to a user. Follow the steps below to use the Graph Explorer tool to view licenses assigned to a user:
279+
You can find your current Teams license using [licenseDetails](/graph/api/resources/licensedetails) Microsoft Graph API that returns the licenses assigned to a user. Follow these steps to use the Graph Explorer tool to view licenses assigned to a user:
295280

296281
1. Open your browser and navigate to [Graph Explorer](https://developer.microsoft.com/graph/graph-explorer)
297282
1. Sign in to Graph Explorer using the credentials.

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,10 @@ Use the UI Library for mobile native platforms to give local and remote particip
8181

8282
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)
8383

84+
### Audio Only Mode
85+
86+
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)
87+
8488
### Orientation
8589

8690
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)

0 commit comments

Comments
 (0)