2016-10-11 09:23:08 -04:00
# Microsoft Bot Framework Web Chat
2016-10-10 19:52:23 -04:00
2016-10-11 08:21:49 -04:00
## Summary
2016-10-11 16:06:37 -04:00
A web part that acts as a web chat component for bot's built on the Microsoft Bot Framework using the Direct Line API. When sending messages
the web part uses the username of the currently logged in user. The web part has settings for color for branding purposes.
2016-10-10 19:52:23 -04:00
2016-10-11 16:06:37 -04:00
2016-10-10 19:52:23 -04:00
2016-10-11 08:21:49 -04:00
## Applies to
2016-10-10 19:52:23 -04:00
2016-10-11 08:21:49 -04:00
* [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 )
2016-10-11 09:23:08 -04:00
* [Microsoft Bot Framework ](http://dev.botframework.com )
2016-10-10 19:52:23 -04:00
2016-10-11 08:21:49 -04:00
## Prerequisites
2016-10-11 16:06:37 -04:00
> 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
2016-10-11 09:23:08 -04:00
over at [www.garypretty.co.uk/category/microsoft-bot-framework/ ](http://www.garypretty.co.uk/category/microsoft-bot-framework/ )
2016-10-10 19:52:23 -04:00
2016-10-11 08:21:49 -04:00
## Solution
Solution|Author(s)
--------|---------
2016-10-11 09:23:08 -04:00
bot-framework | Gary Pretty ([@garypretty](http://www.twitter.com/garypretty), [garypretty.co.uk ](www.garypretty.co.uk ))
2016-10-11 08:21:49 -04:00
## Version history
Version|Date|Comments
-------|----|--------
2016-10-11 09:23:08 -04:00
1.0|October 11th, 2016|Initial release
2016-10-11 08:21:49 -04:00
## 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.**
---
## Minimal Path to Awesome
- Clone this repository
- in the command line run:
- `npm install`
- `tsd install`
- `gulp serve`
2016-10-11 09:23:08 -04:00
- Register your bot in the Microsoft Bot Framework Portal, configure the Direct Line channel on the bot and obtain your Direct Line secret.
2016-10-11 08:21:49 -04:00
2016-10-11 16:06:37 -04:00
## Features
2016-10-11 08:21:49 -04:00
This Web Part illustrates the following concepts on top of the SharePoint Framework:
2016-10-11 09:23:08 -04:00
- 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
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 ).
2016-10-11 16:06:37 -04:00
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
2016-10-11 09:23:08 -04:00
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
2016-10-11 16:06:37 -04:00
Currently this web part only supports plain text conversations with a bot. Other message types,
2016-10-11 09:23:08 -04:00
such as Rich Cards and Attachments are not supported, but are on the roadmap for a future update.
2016-10-11 08:21:49 -04:00
2016-10-11 09:23:08 -04:00
< img src = "https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/react-bot-framework" / >
