From e1bc8122ac3f7c77bce420fa44c97636cb1c4a14 Mon Sep 17 00:00:00 2001 From: Corina <14900841+corinagum@users.noreply.github.com> Date: Fri, 26 Jul 2019 10:59:14 -0700 Subject: [PATCH 1/7] Create ACTIVITYTYPES.md --- ACTIVITYTYPES.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 ACTIVITYTYPES.md diff --git a/ACTIVITYTYPES.md b/ACTIVITYTYPES.md new file mode 100644 index 0000000000..5347626027 --- /dev/null +++ b/ACTIVITYTYPES.md @@ -0,0 +1,26 @@ +## What Activity Types does Web Chat support? + +First, see the [Activities overview](https://docs.microsoft.com/en-us/azure/bot-service/dotnet/bot-builder-dotnet-activities?view=azure-bot-service-3.0) documentation to learn about what activities types are available in Bot Framework. + +This document will discuss what Bot Framework Activity Types that Web Chat is prepared to handle *as a client*. To see documentation on which activity types are supported by server-side Channels, please see the [Activities by Channel](https://github.com/microsoft/botframework-sdk/issues/5294) documentation. + +Although the Direct Line Channel (Web Chat's Bot Framework Channel) supports the following activity types, Web Chat is only designed to support the following activities: + +| Server :left_right_arrow: Bot Activity only | Direct Line Channel supported Activity | Web Chat supported Activity | +|--------------------------------------------- |---------------------------------------- |----------------------------- | +| | `Message` | :heavy_check_mark: | +| :heavy_check_mark: | `ConversationUpdate` | | +| | `Event` | :heavy_check_mark: | +| :heavy_check_mark: | `Event.TokenResponse` | | +| | `EndOfConversation` | | +| | `Typing` | :heavy_check_mark: | +| :heavy_check_mark: | `InstallationUpdate` | | + + +- `InstallationUpdate`, `Event.TokenResponse` and `ConversationUpdate`are activities sent between the bot and the server. Web Chat the client is not designed to render these activities by default. +- `EndOfConversation` is not currently rendered by Web Chat. See the Web Chat conversation on [Activity Types](https://github.com/microsoft/BotFramework-WebChat/issues/1808) to learn more. + +When developing your bot's web page, you may discover that the bot sends an activity type that needs to be supported by Web Chat. Luckily, it is possible to create renderers for different activities through the [`activityMiddleware`](https://github.com/microsoft/BotFramework-WebChat#web-chat-api-reference). To learn more, check out the following tutorials: + +1. [Customize Web Chat with Reaction Buttons](https://github.com/microsoft/BotFramework-WebChat/tree/master/samples/09.customization-reaction-buttons/) +1. [Customize Web Chat with GitHub Stargazer Components](https://github.com/microsoft/BotFramework-WebChat/tree/master/samples/10.a.customization-card-components) From e70562554766012b2db45601d039f1ce205e92e5 Mon Sep 17 00:00:00 2001 From: Corina <14900841+corinagum@users.noreply.github.com> Date: Fri, 26 Jul 2019 13:36:17 -0700 Subject: [PATCH 2/7] Add note about not using custom activity types --- ACTIVITYTYPES.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/ACTIVITYTYPES.md b/ACTIVITYTYPES.md index 5347626027..347645ab2e 100644 --- a/ACTIVITYTYPES.md +++ b/ACTIVITYTYPES.md @@ -24,3 +24,6 @@ When developing your bot's web page, you may discover that the bot sends an acti 1. [Customize Web Chat with Reaction Buttons](https://github.com/microsoft/BotFramework-WebChat/tree/master/samples/09.customization-reaction-buttons/) 1. [Customize Web Chat with GitHub Stargazer Components](https://github.com/microsoft/BotFramework-WebChat/tree/master/samples/10.a.customization-card-components) + + +Note: The Web Chat team does not recommend creating custom Activity Types. Instead, use the `Event` Activity Type. From 68b824612e4ffde84460bbe33f0b54e004c86ff5 Mon Sep 17 00:00:00 2001 From: Corina <14900841+corinagum@users.noreply.github.com> Date: Fri, 26 Jul 2019 16:46:00 -0700 Subject: [PATCH 3/7] Apply suggestions from code review Co-Authored-By: William Wong --- ACTIVITYTYPES.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/ACTIVITYTYPES.md b/ACTIVITYTYPES.md index 347645ab2e..f60e861a2b 100644 --- a/ACTIVITYTYPES.md +++ b/ACTIVITYTYPES.md @@ -2,9 +2,9 @@ First, see the [Activities overview](https://docs.microsoft.com/en-us/azure/bot-service/dotnet/bot-builder-dotnet-activities?view=azure-bot-service-3.0) documentation to learn about what activities types are available in Bot Framework. -This document will discuss what Bot Framework Activity Types that Web Chat is prepared to handle *as a client*. To see documentation on which activity types are supported by server-side Channels, please see the [Activities by Channel](https://github.com/microsoft/botframework-sdk/issues/5294) documentation. +This document will discuss what Bot Framework Activity Types that Web Chat is prepared to handle *as a client*. To see documentation on which activity types are supported by server-side channels, please see the [Activities by Channel](https://github.com/microsoft/botframework-sdk/issues/5294) documentation. -Although the Direct Line Channel (Web Chat's Bot Framework Channel) supports the following activity types, Web Chat is only designed to support the following activities: +Although the Direct Line channel and Web Chat channel supports the following activity types, Web Chat is only designed to support the following activities: | Server :left_right_arrow: Bot Activity only | Direct Line Channel supported Activity | Web Chat supported Activity | |--------------------------------------------- |---------------------------------------- |----------------------------- | @@ -18,7 +18,7 @@ Although the Direct Line Channel (Web Chat's Bot Framework Channel) supports the - `InstallationUpdate`, `Event.TokenResponse` and `ConversationUpdate`are activities sent between the bot and the server. Web Chat the client is not designed to render these activities by default. -- `EndOfConversation` is not currently rendered by Web Chat. See the Web Chat conversation on [Activity Types](https://github.com/microsoft/BotFramework-WebChat/issues/1808) to learn more. +- `EndOfConversation` is not currently handled or rendered by Web Chat. See the Web Chat conversation on [Activity Types](https://github.com/microsoft/BotFramework-WebChat/issues/1808) to learn more. When developing your bot's web page, you may discover that the bot sends an activity type that needs to be supported by Web Chat. Luckily, it is possible to create renderers for different activities through the [`activityMiddleware`](https://github.com/microsoft/BotFramework-WebChat#web-chat-api-reference). To learn more, check out the following tutorials: @@ -26,4 +26,4 @@ When developing your bot's web page, you may discover that the bot sends an acti 1. [Customize Web Chat with GitHub Stargazer Components](https://github.com/microsoft/BotFramework-WebChat/tree/master/samples/10.a.customization-card-components) -Note: The Web Chat team does not recommend creating custom Activity Types. Instead, use the `Event` Activity Type. +Note: We do not recommend creating custom Activity Types. Instead, please use the `event` activity type. From b465dde587d3e20d7cc8b53f53ca2ae0b9e17beb Mon Sep 17 00:00:00 2001 From: Corina <14900841+corinagum@users.noreply.github.com> Date: Sat, 27 Jul 2019 13:28:47 -0700 Subject: [PATCH 4/7] Apply fixes to Activity Types documentation --- ACTIVITYTYPES.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/ACTIVITYTYPES.md b/ACTIVITYTYPES.md index f60e861a2b..0d20e34576 100644 --- a/ACTIVITYTYPES.md +++ b/ACTIVITYTYPES.md @@ -2,23 +2,23 @@ First, see the [Activities overview](https://docs.microsoft.com/en-us/azure/bot-service/dotnet/bot-builder-dotnet-activities?view=azure-bot-service-3.0) documentation to learn about what activities types are available in Bot Framework. -This document will discuss what Bot Framework Activity Types that Web Chat is prepared to handle *as a client*. To see documentation on which activity types are supported by server-side channels, please see the [Activities by Channel](https://github.com/microsoft/botframework-sdk/issues/5294) documentation. +This document will discuss what Bot Framework Activity Types that Web Chat is prepared to handle *as a client*. To see documentation on which activity types are supported by different channels, please see the [Activities by Channel](https://github.com/microsoft/botframework-sdk/issues/5294) discussion. -Although the Direct Line channel and Web Chat channel supports the following activity types, Web Chat is only designed to support the following activities: +Although the Direct Line channel and Web Chat channel support the following activity types, Web Chat is only designed to support the following activities: -| Server :left_right_arrow: Bot Activity only | Direct Line Channel supported Activity | Web Chat supported Activity | -|--------------------------------------------- |---------------------------------------- |----------------------------- | -| | `Message` | :heavy_check_mark: | -| :heavy_check_mark: | `ConversationUpdate` | | -| | `Event` | :heavy_check_mark: | -| :heavy_check_mark: | `Event.TokenResponse` | | -| | `EndOfConversation` | | -| | `Typing` | :heavy_check_mark: | -| :heavy_check_mark: | `InstallationUpdate` | | +| Direct Line Channel supported Activity | Channel :left_right_arrow: Bot Activity | `Activity.type` | +|---------------------------------------- |---------------------------------------- |------------------- | +| `message` | | :heavy_check_mark: | +| `conversationUpdate` | :heavy_check_mark: | | +| `event` | | :heavy_check_mark: | +| `event.TokenResponse` | :heavy_check_mark: | | +| `endOfConversation` | | | +| `typing` | | :heavy_check_mark: | +| `installationUpdate` | :heavy_check_mark: | | -- `InstallationUpdate`, `Event.TokenResponse` and `ConversationUpdate`are activities sent between the bot and the server. Web Chat the client is not designed to render these activities by default. -- `EndOfConversation` is not currently handled or rendered by Web Chat. See the Web Chat conversation on [Activity Types](https://github.com/microsoft/BotFramework-WebChat/issues/1808) to learn more. +- `installationUpdate`, `event.TokenResponse` and `conversationUpdate` are activities sent between the bot and the channel. The channel does not send these events to Web Chat. +- `endOfConversation` is not currently handled or rendered by Web Chat. See the Web Chat conversation on [Activity Types](https://github.com/microsoft/BotFramework-WebChat/issues/1808) to learn more. When developing your bot's web page, you may discover that the bot sends an activity type that needs to be supported by Web Chat. Luckily, it is possible to create renderers for different activities through the [`activityMiddleware`](https://github.com/microsoft/BotFramework-WebChat#web-chat-api-reference). To learn more, check out the following tutorials: From 2ccbefdb06feab746c134a67b8d2f81de4d49cff Mon Sep 17 00:00:00 2001 From: Corina <14900841+corinagum@users.noreply.github.com> Date: Sat, 27 Jul 2019 14:03:03 -0700 Subject: [PATCH 5/7] Update README and CHANGELOG --- CHANGELOG.md | 1 + README.md | 3 +++ 2 files changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index c23532e4f8..66141d1d16 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -60,6 +60,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ### Added - Added bubble nub and style options, by [@compulim](https://github.com/compulim), in PR [#2137](https://github.com/Microsoft/BotFramework-WebChat/pull/2137) +- [#1808](https://github.com/microsoft/BotFramework-WebChat/issues/1808) Added documentation on activity types, by [@corinagum](https://github.com/corinagum) in PR [#2228](https://github.com/microsoft/BotFramework-WebChat/pull/2228) ### Samples diff --git a/README.md b/README.md index bf5f645eba..65739a7632 100644 --- a/README.md +++ b/README.md @@ -150,6 +150,9 @@ Web Chat is designed to be customizable without forking the source code. The tab See more about [customizing Web Chat](https://github.com/microsoft/BotFramework-WebChat/blob/master/SAMPLES.md) to learn more on customization. +# Supported Activity Types on the Web Chat Client +[Web Chat and Activity Types](https://github.com/microsoft/BotFramework-WebChat/blob/master/ACTIVITYTYPES.md) + ## Speech changes in Web Chat 4.5 > This is a breaking change on behavior expectations regarding speech in Web Chat. From 108d59cbc192bad52a4a248ade0648831436951f Mon Sep 17 00:00:00 2001 From: Corina <14900841+corinagum@users.noreply.github.com> Date: Tue, 30 Jul 2019 16:13:43 -0700 Subject: [PATCH 6/7] Apply suggestions from code review Co-Authored-By: William Wong --- ACTIVITYTYPES.md | 4 ++-- CHANGELOG.md | 2 +- README.md | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/ACTIVITYTYPES.md b/ACTIVITYTYPES.md index 0d20e34576..d4d0dd4ddd 100644 --- a/ACTIVITYTYPES.md +++ b/ACTIVITYTYPES.md @@ -2,7 +2,7 @@ First, see the [Activities overview](https://docs.microsoft.com/en-us/azure/bot-service/dotnet/bot-builder-dotnet-activities?view=azure-bot-service-3.0) documentation to learn about what activities types are available in Bot Framework. -This document will discuss what Bot Framework Activity Types that Web Chat is prepared to handle *as a client*. To see documentation on which activity types are supported by different channels, please see the [Activities by Channel](https://github.com/microsoft/botframework-sdk/issues/5294) discussion. +This document will discuss what Bot Framework activity types that Web Chat is prepared to handle *as a client*. To see documentation on which activity types are supported by different channels, please see the [Activities by Channel](https://github.com/microsoft/botframework-sdk/issues/5294) discussion. Although the Direct Line channel and Web Chat channel support the following activity types, Web Chat is only designed to support the following activities: @@ -26,4 +26,4 @@ When developing your bot's web page, you may discover that the bot sends an acti 1. [Customize Web Chat with GitHub Stargazer Components](https://github.com/microsoft/BotFramework-WebChat/tree/master/samples/10.a.customization-card-components) -Note: We do not recommend creating custom Activity Types. Instead, please use the `event` activity type. +Note: We do not recommend creating custom activity types. Instead, please use the `event` activity type. diff --git a/CHANGELOG.md b/CHANGELOG.md index 9216ea08cf..949b69d518 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -63,7 +63,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ### Added - Added bubble nub and style options, by [@compulim](https://github.com/compulim), in PR [#2137](https://github.com/Microsoft/BotFramework-WebChat/pull/2137) -- [#1808](https://github.com/microsoft/BotFramework-WebChat/issues/1808) Added documentation on activity types, by [@corinagum](https://github.com/corinagum) in PR [#2228](https://github.com/microsoft/BotFramework-WebChat/pull/2228) +- Fix [#1808](https://github.com/microsoft/BotFramework-WebChat/issues/1808). Added documentation on activity types, by [@corinagum](https://github.com/corinagum) in PR [#2228](https://github.com/microsoft/BotFramework-WebChat/pull/2228) ### Samples diff --git a/README.md b/README.md index 65739a7632..cda6a94e11 100644 --- a/README.md +++ b/README.md @@ -150,8 +150,8 @@ Web Chat is designed to be customizable without forking the source code. The tab See more about [customizing Web Chat](https://github.com/microsoft/BotFramework-WebChat/blob/master/SAMPLES.md) to learn more on customization. -# Supported Activity Types on the Web Chat Client -[Web Chat and Activity Types](https://github.com/microsoft/BotFramework-WebChat/blob/master/ACTIVITYTYPES.md) +## Supported Activity Types on the Web Chat Client +Please refer to [`ACTIVITYTYPES.md`](https://github.com/microsoft/BotFramework-WebChat/blob/master/ACTIVITYTYPES.md) for list of Web Chat supported activity types. ## Speech changes in Web Chat 4.5 From 8c61cf61b49313fd5ba5b547d7c17878f2cb8532 Mon Sep 17 00:00:00 2001 From: Corina <14900841+corinagum@users.noreply.github.com> Date: Tue, 30 Jul 2019 16:43:42 -0700 Subject: [PATCH 7/7] Spacing fixes on ACTIVITYTYPES.md --- ACTIVITYTYPES.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/ACTIVITYTYPES.md b/ACTIVITYTYPES.md index d4d0dd4ddd..ff8245890f 100644 --- a/ACTIVITYTYPES.md +++ b/ACTIVITYTYPES.md @@ -16,7 +16,6 @@ Although the Direct Line channel and Web Chat channel support the following acti | `typing` | | :heavy_check_mark: | | `installationUpdate` | :heavy_check_mark: | | - - `installationUpdate`, `event.TokenResponse` and `conversationUpdate` are activities sent between the bot and the channel. The channel does not send these events to Web Chat. - `endOfConversation` is not currently handled or rendered by Web Chat. See the Web Chat conversation on [Activity Types](https://github.com/microsoft/BotFramework-WebChat/issues/1808) to learn more. @@ -25,5 +24,4 @@ When developing your bot's web page, you may discover that the bot sends an acti 1. [Customize Web Chat with Reaction Buttons](https://github.com/microsoft/BotFramework-WebChat/tree/master/samples/09.customization-reaction-buttons/) 1. [Customize Web Chat with GitHub Stargazer Components](https://github.com/microsoft/BotFramework-WebChat/tree/master/samples/10.a.customization-card-components) - Note: We do not recommend creating custom activity types. Instead, please use the `event` activity type.