Update bot-framework sample readme
This commit is contained in:
parent
9bc247ff1a
commit
318960f2a9
|
@ -1,4 +1,4 @@
|
||||||
# title of the sample
|
# Microsoft Bot Framework Web Chat
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
Short summary on functionality and used technologies.
|
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)
|
* [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)
|
* [Office 365 developer tenant](http://dev.office.com/sharepoint/docs/spfx/set-up-your-developer-tenant)
|
||||||
|
* [Microsoft Bot Framework](http://dev.botframework.com)
|
||||||
> Update accordingly as needed.
|
|
||||||
|
|
||||||
## Prerequisites
|
## 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
|
||||||
|
|
||||||
Solution|Author(s)
|
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 history
|
||||||
|
|
||||||
Version|Date|Comments
|
Version|Date|Comments
|
||||||
-------|----|--------
|
-------|----|--------
|
||||||
1.1|September 2, 2025|Update comment
|
1.0|October 11th, 2016|Initial release
|
||||||
1.0|August 29, 2025|Initial release
|
|
||||||
|
|
||||||
## Disclaimer
|
## 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.**
|
**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`
|
- `tsd install`
|
||||||
- `gulp serve`
|
- `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
|
## Features
|
||||||
Description of the web part with possible additional details than in short summary.
|
|
||||||
This Web Part illustrates the following concepts on top of the SharePoint Framework:
|
This Web Part illustrates the following concepts on top of the SharePoint Framework:
|
||||||
|
|
||||||
- topic 1
|
- Connecting and communicating with a bot built on the Microsoft Bot Framework using the Direct Line Channel
|
||||||
- topic 2
|
- Validating Property Pane Settings
|
||||||
- topic 3
|
- Office UI Fabric
|
||||||
|
- React
|
||||||
|
|
||||||
<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/readme-template" />
|
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.
|
||||||
|
|
||||||
|
<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/react-bot-framework" />
|
Loading…
Reference in New Issue