From 318960f2a96d2eac6c3827badf07104ad7d6a10e Mon Sep 17 00:00:00 2001 From: "MANDOGROUP\\gary.pretty" Date: Tue, 11 Oct 2016 14:23:08 +0100 Subject: [PATCH] Update bot-framework sample readme --- samples/react-bot-framework/README.md | 43 ++++++++++++++++++--------- 1 file changed, 29 insertions(+), 14 deletions(-) diff --git a/samples/react-bot-framework/README.md b/samples/react-bot-framework/README.md index c066b083f..70a7bf252 100644 --- a/samples/react-bot-framework/README.md +++ b/samples/react-bot-framework/README.md @@ -1,4 +1,4 @@ -# title of the sample +# Microsoft Bot Framework Web Chat ## Summary Short summary on functionality and used technologies. @@ -9,25 +9,26 @@ Short summary on functionality and used technologies. * [SharePoint Framework Developer Preview](http://dev.office.com/sharepoint/docs/spfx/sharepoint-framework-overview) * [Office 365 developer tenant](http://dev.office.com/sharepoint/docs/spfx/set-up-your-developer-tenant) - -> Update accordingly as needed. +* [Microsoft Bot Framework](http://dev.botframework.com) ## Prerequisites -> Any special pre-requisites? +> You need to have a bot created and registered using the Microsoft Bot Framework and registered to use the Direct Line Channel, +which will give you the secret needed when adding this web part to the page. For more information on creating a bot and registering +the channel you can see the official web site at [dev.botframework.com](http://dev.botframework.com), as well as various tutorials +over at [www.garypretty.co.uk/category/microsoft-bot-framework/](http://www.garypretty.co.uk/category/microsoft-bot-framework/) ## Solution Solution|Author(s) --------|--------- -folder name | Author details +bot-framework | Gary Pretty ([@garypretty](http://www.twitter.com/garypretty), [garypretty.co.uk](www.garypretty.co.uk)) ## Version history Version|Date|Comments -------|----|-------- -1.1|September 2, 2025|Update comment -1.0|August 29, 2025|Initial release +1.0|October 11th, 2016|Initial release ## Disclaimer **THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.** @@ -42,14 +43,28 @@ Version|Date|Comments - `tsd install` - `gulp serve` -> Include any additional steps as needed. +- Register your bot in the Microsoft Bot Framework Portal, configure the Direct Line channel on the bot and obtain your Direct Line secret. -## Features -Description of the web part with possible additional details than in short summary. +## Features This Web Part illustrates the following concepts on top of the SharePoint Framework: -- topic 1 -- topic 2 -- topic 3 +- Connecting and communicating with a bot built on the Microsoft Bot Framework using the Direct Line Channel +- Validating Property Pane Settings +- Office UI Fabric +- React - \ No newline at end of file +When adding the web part to a page you need to obtain your Bot Direct Line Channel secret via the [Bot Framework Portal](http://dev.botframework.com). +You then add this secret via the Property Pane of the web part. If there is an error initializing the Direct Line Client with the bot then they will +be shown in the console within the browser. + +Additional settings can be set to style the web part, including; + + - Display title of the web part + - Web part header background color + - Placeholder text + - Foreground / background colors for messages, both from the user and from the bot + +Currently this web part only supports plain text conversations with a bot. Other message types, +such as Rich Cards and Attachments are not supported, but are on the roadmap for a future update. + + \ No newline at end of file