Skip to content

Commit f221a33

Browse files
authored
Merge pull request #285200 from Leah-Xia-Microsoft/feature/add-rich-text-editor-documentation
[ACS][Chat]Add rich text editor documentation
2 parents 7d223ad + 6148419 commit f221a33

File tree

5 files changed

+41
-12
lines changed

5 files changed

+41
-12
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,17 +43,17 @@ Get more conceptual documentation, quickstarts, and examples in the [UI Library
4343
| Area | Azure Communication Services Chat | Teams Interoperability Chat |
4444
| ------------ | ------------------------------------------------ | ------------------------------------------- |
4545
| Chat types | Join an Azure Communication Services chat thread | Join a Microsoft Teams meeting chat |
46-
| Chat actions | Send and receive text messages | Send and receive text messages |
47-
| | Receive rich text messages | Receive rich text messages |
48-
| | - | [Receive inline images\*](../../../tutorials/inline-image-tutorial-interop-chat.md) |
46+
| Chat actions | Send and receive text messages | Send and receive text messages |
47+
| | Send and receive rich text messages\* | Send and receive rich text messages\* |
48+
| | - | [Receive inline images](../../../tutorials/inline-image-tutorial-interop-chat.md) |
4949
| | [Send and receive file attachments](../../../tutorials/file-sharing-tutorial-acs-chat.md) | [Receive file attachments\*](../../../tutorials/file-sharing-tutorial-interop-chat.md) |
5050
| Chat events | Send and receive typing indicators | Send and receive typing indicators\*\* |
5151
| | Send and receive read receipts | Send and receive read receipts |
5252
| | Show when a participant is added or removed | Show when a participant is added or removed |
5353
| Participants | Show a participant roster | Show a participant roster |
5454

5555

56-
\*Inline image and file attachment support are currently in public preview. Preview APIs and SDKs are provided without a service-level agreement. We recommend that you don't use them for production workloads. Some features might not be supported, or they might have constrained capabilities. For more information, review [Supplemental Terms of Use for Microsoft Azure Previews.](https://azure.microsoft.com/support/legal/preview-supplemental-terms/)
56+
\*Send rich text messages and file attachment support are currently in public preview. Preview APIs and SDKs are provided without a service-level agreement. We recommend that you don't use them for production workloads. Some features might not be supported, or they might have constrained capabilities. For more information, review [Supplemental Terms of Use for Microsoft Azure Previews.](https://azure.microsoft.com/support/legal/preview-supplemental-terms/)
5757

5858
\*\*The display name of typing event from the Teams user might not be shown properly.
5959

articles/communication-services/quickstarts/ui-library/includes/get-started-chat/web.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@ ms.service: azure-communication-services
1818

1919
### You can access the following quickstarts
2020

21+
- [UI Components](https://github.com/Azure-Samples/communication-services-javascript-quickstarts/tree/main/ui-library-quickstart-ui-components)
22+
- [Composites](https://github.com/Azure-Samples/communication-services-javascript-quickstarts/tree/main/ui-library-quickstart-composites)
23+
- [Stateful Client (Chat)](https://github.com/Azure-Samples/communication-services-javascript-quickstarts/tree/main/ui-library-starting-with-chat-stateful)
24+
25+
### You can access the following storybooks
26+
2127
- [UI Components](https://azure.github.io/communication-ui-library/?path=/story/quickstarts-uicomponents--page)
2228
- [Composites](https://azure.github.io/communication-ui-library/?path=/story/quickstarts-composites--page)
2329
- [Stateful Client (Chat)](https://azure.github.io/communication-ui-library/?path=/story/composites-chat-basicexample--basic-example)

articles/communication-services/tutorials/inline-image-tutorial-interop-chat.md

Lines changed: 31 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,19 @@ ms.subservice: chat
1313

1414
# Enable inline image using UI Library in Teams Interoperability Chat
1515

16-
In a Teams Interoperability Chat ("Interop Chat"), we can enable Azure Communication Service end users to receive inline images sent by Teams users. Currently, the Azure Communication Service end user is able to only receive inline images from the Teams user. Refer to [UI Library Use Cases](../concepts/ui-library/ui-library-use-cases.md) to learn more.
16+
In a Teams Interoperability Chat ("Interop Chat"), we can enable Azure Communication Service end users to receive inline images sent by Teams users. Additionally, when rich text editor is enabled, Azure Communication Service end users can send inline images to Teams users. Refer to [UI Library Use Cases](../concepts/ui-library/ui-library-use-cases.md) to learn more.
1717

18-
>[!IMPORTANT]
18+
> [!IMPORTANT]
1919
>
20-
>Inline image feature comes with the CallWithChat Composite without additional setups.
20+
> Receiving inline images feature comes with the CallWithChat Composite without additional setups.
21+
> Sending inline images feature can be enabled by set `richTextEditor` to true under the CallWithChatCompositeOptions.
22+
23+
> [!IMPORTANT]
24+
> The sending inline image feature of Azure Communication Services is currently in preview.
25+
>
26+
> Preview APIs and SDKs are provided without a service-level agreement. We recommend that you don't use them for production workloads. Some features might not be supported, or they might have constrained capabilities.
2127
>
28+
> For more information, review [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
2229
2330

2431
## Download code
@@ -31,14 +38,14 @@ Access the code for this tutorial on [GitHub](https://github.com/Azure-Samples/c
3138
- [Visual Studio Code](https://code.visualstudio.com/) on one of the [supported platforms](https://code.visualstudio.com/docs/supporting/requirements#_platforms).
3239
- [Node.js](https://nodejs.org/), Active LTS and Maintenance LTS versions. Use the `node --version` command to check your version.
3340
- An active Communication Services resource and connection string. [Create a Communication Services resource](../quickstarts/create-communication-resource.md).
34-
- Using the UI library version [1.15.0](https://www.npmjs.com/package/@azure/communication-react/v/1.15.0) or the latest.
41+
- Using the UI library version [1.15.0](https://www.npmjs.com/package/@azure/communication-react/v/1.15.0) or the latest for receiving inline images. Using the UI library version [1.19.0-beta.1](https://www.npmjs.com/package/@azure/communication-react/v/1.19.0-beta.1) or the latest beta version for sending inline images.
3542
- Have a Teams meeting created and the meeting link ready.
3643
- Be familiar with how [ChatWithChat Composite](https://azure.github.io/communication-ui-library/?path=/docs/composites-call-with-chat-basicexample--basic-example) works.
3744

3845

3946
## Background
4047

41-
First of all, we need to understand that Teams Interop Chat has to part of a Teams meeting currently. When the Teams user creates an online meeting, a chat thread would be created and associated with the meeting. To enable the Azure Communication Service end user joining the chat and starting to send/receive messages, a meeting participant (a Teams user) would need to admit them to the call first. Otherwise, they don't have access to the chat.
48+
First of all, we need to understand that Teams Interop Chat has to be part of a Teams meeting currently. When the Teams user creates an online meeting, a chat thread would be created and associated with the meeting. To enable the Azure Communication Service end user joining the chat and starting to send/receive messages, a meeting participant (a Teams user) would need to admit them to the call first. Otherwise, they don't have access to the chat.
4249

4350
Once the Azure Communication Service end user is admitted to the call, they would be able to start to chat with other participants on the call. In this tutorial, we're checking out how inline image works in Interop chat.
4451

@@ -65,15 +72,24 @@ export type CallWithChatExampleProps = {
6572
callInvitationURL?: string;
6673
};
6774

75+
```
76+
There no specific setup needed to enable receiving inline images. However, to be able to send inline images, `richTextEditor` function need to be enabled through the `CallWithChatExampleProps`. Here's a code snippet on how to enable it:
77+
```js
78+
<CallWithChatExperience
79+
// ...any other call with chat props
80+
compositeOptions={{ richTextEditor: true }}
81+
/>
82+
6883
```
6984

85+
7086
To be able to start the Composite for meeting chat, we need to pass `TeamsMeetingLinkLocator`, which looks like this:
7187

7288
```js
7389
{ "meetingLink": "<TEAMS_MEETING_LINK>" }
7490
```
7591

76-
This is all you need - and there's no other setup needed to enable inline image specifically.
92+
This is all you need - and there's no other setup needed.
7793

7894

7995
## Run the code
@@ -88,12 +104,19 @@ Simply click on the chat button located in the bottom to reveal the chat panel a
88104

89105
![Screenshot of Azure Communication Services UI library receiving two inline images.](./media/inline-image-tutorial-interop-chat-2.png "Screenshot of Azure Communication Services UI library receiving 2 inline images.")
90106

91-
Note that in a Teams Interop Chat, we currently only support Azure Communication Service end user to receive inline images sent by the Teams user. To learn more about what features are supported, refer to the [UI Library use cases](../concepts/ui-library/ui-library-use-cases.md)
107+
108+
When sending inline images is enabled, you should see something like the following screenshot:
109+
![Screenshot of Azure Communication Services UI library sending two inline images and editing messages.](./media/inline-image-tutorial-interop-chat-3.png "Screenshot of Azure Communication Services UI library sending 2 inline images and editing messages.")
110+
111+
!["Screenshot of a Teams client receiving 2 inline images."](./media/inline-image-tutorial-interop-chat-4.png "Screenshot of a Teams client receiving 2 inline images.")
112+
92113

93114
## Known Issues
94115

95116
* The UI library might not support certain GIF images at this time. The user might receive a static image instead.
96-
* the Web UI library doesn't support Clips (short videos) sent by the Teams users at this time.
117+
* The Web UI library doesn't support Clips (short videos) sent by the Teams users at this time.
118+
* For certain Android devices, pasting of a single image is only supported when long pressing on the rich text editor and choosing
119+
paste. Selecting from the clipboard view from keyboard may not be supported.
97120

98121

99122
## Next steps
293 KB
Loading
1.69 MB
Loading

0 commit comments

Comments
 (0)