Skip to content

Commit 4100a13

Browse files
chengyuanlai-msftchengyuanlai-msft
committed
added error code for data channel
1 parent 83cd37d commit 4100a13

File tree

3 files changed

+30
-4
lines changed

3 files changed

+30
-4
lines changed

‎articles/communication-services/quickstarts/voice-video-calling/includes/data-channel/data-channel-android.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,11 @@ titleSuffix: An Azure Communication Services document
55
description: In this quickstart, you learn how to add data channel messaging to your existing Android calling app using Azure Communication Services.
66
author: sloanster
77
services: azure-communication-services
8-
ms.date: 05/04/2023
8+
ms.date: 03/01/2024
99
ms.topic: include
1010
ms.service: azure-communication-services
1111
ms.subservice: calling
1212
---
13-
1413
[!INCLUDE [Public Preview](../../../../includes/public-preview-include-document.md)]
1514
>[!IMPORTANT]
1615
> Please be aware that the current Data Channel feature API doesn't support direct messaging between a web browser and a native app in a peer-to-peer call scenario.
@@ -31,6 +30,15 @@ Refer to the [Voice Calling Quickstart](../../getting-started-with-calling.md?pi
3130
| - | - |
3231
| DataChannelPriority | Describes the priority options of data channel. Values: { `NORMAL`, `HIGH` }. |
3332
| DataChannelReliability | Describes the reliability options of data channel. Values: { `LOSSY`, `DURABLE` }. |
33+
### Error Code
34+
| Name | Description |
35+
| - | - |
36+
| _DATA_CHANNEL_FAILED_TO_START_ | `getDataChannelSender()` can fail with this error code, indicating underlying Data Channel is not ready to be used. |
37+
| _DATA_CHANNEL_RANDOM_ID_NOT_AVAILABLE_ | `getDataChannelSender()` can fail with this error code, indicating all available random channel ids have already been used. |
38+
| _DATA_CHANNEL_SENDER_CLOSED_ | `sendMessage()` can fail with this error code, indicating the sender has already been closed previously. |
39+
| _DATA_CHANNEL_MESSAGE_SIZE_OVER_LIMIT_ | `sendMessage()` can fail with this error code, indicating the message data size exceeds the limit. You can get the message size limit using `getMaxMessageSizeInBytes()` in `DataChannelSender`. |
40+
| _DATA_CHANNEL_MESSAGE_FAILURE_FOR_BANDWIDTH_ | `sendMessage()` can fail with this error code, indicating a failure in sending the message due to not enough bandwidth. |
41+
| _DATA_CHANNEL_MESSAGE_FAILURE_FOR_TRAFFIC_LIMIT_ | `sendMessage()` can fail with this error code, indicating a failure in sending the message due to the overall usage of Data Channel not in compliance with the traffic limit rules. Refer to [Data Channel Concept Document](../../../../concepts/voice-video-calling/data-channel.md) for details of the traffic limit. |
3442
### Methods
3543
#### Enable Data Channel feature
3644

‎articles/communication-services/quickstarts/voice-video-calling/includes/data-channel/data-channel-ios.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ titleSuffix: An Azure Communication Services document
55
description: In this quickstart, you learn how to add data channel messaging to your existing iOS calling app using Azure Communication Services.
66
author: sloanster
77
services: azure-communication-services
8-
ms.date: 05/04/2023
8+
ms.date: 03/01/2024
99
ms.topic: include
1010
ms.service: azure-communication-services
1111
ms.subservice: calling
@@ -31,6 +31,15 @@ Refer to the [Voice Calling Quickstart](../../getting-started-with-calling.md?pi
3131
| - | - |
3232
| DataChannelPriority | Describes the priority options of data channel. Values: { `normal`, `high` }. |
3333
| DataChannelReliability | Describes the reliability options of data channel. Values: { `lossy`, `durable` }. |
34+
### Error Code
35+
| Name | Description |
36+
| - | - |
37+
| _dataChannelFailedToStart_ | `getDataChannelSender()` can fail with this error code, indicating underlying Data Channel is not ready to be used. |
38+
| _dataChannelRandomIdNotAvailable_ | `getDataChannelSender()` can fail with this error code, indicating all available random channel ids have already been used. |
39+
| _dataChannelSenderClosed_ | `sendMessage()` can fail with this error code, indicating the sender has already been closed previously. |
40+
| _dataChannelMessageSizeOverLimit_ | `sendMessage()` can fail with this error code, indicating the message data size exceeds the limit. You can get the message size limit using `maxMessageSizeInBytes` in `DataChannelSender`. |
41+
| _dataChannelMessageFailureForBandwidth_ | `sendMessage()` can fail with this error code, indicating a failure in sending the message due to not enough bandwidth. |
42+
| _dataChannelMessageFailureForTrafficLimit_ | `sendMessage()` can fail with this error code, indicating a failure in sending the message due to the overall usage of Data Channel not in compliance with the traffic limit rules. Refer to [Data Channel Concept Document](../../../../concepts/voice-video-calling/data-channel.md) for details of the traffic limit. |
3443
### Methods
3544
#### Enable Data Channel feature
3645

‎articles/communication-services/quickstarts/voice-video-calling/includes/data-channel/data-channel-windows.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ titleSuffix: An Azure Communication Services document
55
description: In this quickstart, you learn how to add data channel messaging to your existing Windows calling app using Azure Communication Services.
66
author: sloanster
77
services: azure-communication-services
8-
ms.date: 05/04/2023
8+
ms.date: 03/01/2024
99
ms.topic: include
1010
ms.service: azure-communication-services
1111
ms.subservice: calling
@@ -31,6 +31,15 @@ Refer to the [Voice Calling Quickstart](../../getting-started-with-calling.md?pi
3131
| - | - |
3232
| DataChannelPriority | Describes the priority options of data channel. Values: { `Normal`, `High` }. |
3333
| DataChannelReliability | Describes the reliability options of data channel. Values: { `Lossy`, `Durable` }. |
34+
### Error Code
35+
| Name | Description |
36+
| - | - |
37+
| _DataChannelFailedToStart_ | `GetDataChannelSender()` can fail with this error code, indicating underlying Data Channel is not ready to be used. |
38+
| _DataChannelRandomIdNotAvailable_ | `GetDataChannelSender()` can fail with this error code, indicating all available random channel ids have already been used. |
39+
| _DataChannelSenderClosed_ | `SendMessage()` can fail with this error code, indicating the sender has already been closed previously. |
40+
| _DataChannelMessageSizeOverLimit_ | `SendMessage()` can fail with this error code, indicating the message data size exceeds the limit. You can get the message size limit using `MaxMessageSizeInBytes` in `DataChannelSender`. |
41+
| _DataChannelMessageFailureForBandwidth_ | `SendMessage()` can fail with this error code, indicating a failure in sending the message due to not enough bandwidth. |
42+
| _DataChannelMessageFailureForTrafficLimit_ | `SendMessage()` can fail with this error code, indicating a failure in sending the message due to the overall usage of Data Channel not in compliance with the traffic limit rules. Refer to [Data Channel Concept Document](../../../../concepts/voice-video-calling/data-channel.md) for details of the traffic limit. |
3443
### Methods
3544
#### Enable Data Channel feature
3645

0 commit comments

Comments
 (0)