Skip to content

Commit f6daa3b

Browse files
authored
Release 09-12-2017 (#287)
* merge branch 'live' into master * Changing pluralization of SDKs to SDK (#283) * Community content live sync work (#271) * Update bot-builder-dotnet-quickstart.md Restoring links to the controller & dialog templates that were present in previous documentation * ISO 639-2 recommends use of the language codes in lower case (#175) * Grammar correction. Whose, not Who's (#33) * Updated to correct version of IISExpress (#35) * Update resources-tools-downloads.md (#31) * Update resources-tools-downloads.md Add information for how to install the Visual Studio project templates. * Update resources-tools-downloads.md * Changed AttachmentLayouts to AttachmentLayoutTypes (#38) The types of Attachment Layouts class is called AttachmentLayoutTypes and not AttachmentLayouts. https://docs.botframework.com/en-us/csharp/builder/sdkreference/d7/d87/class_microsoft_1_1_bot_1_1_connector_1_1_attachment_layout_types.html * Removing bad metadata (#183) * Conversation designer (#178) * requires (#186) * Dialog next steps (#177) * Added clarification for ListStyle in Prompts.choice * Minor copy edits. * Add reference to Manage state data topic. * Saving progress... * Bind actions to dialog * Types table link to section instead. * Confirm interruptions * Added some more details and made some minor edits. * Update links to reflect new file name for the 'Handle user actions' topic. * Fix broken link. * minor edits to the Actions topic and cross linking. * fixed broken link * Redirecting to the new topic. * Revised content ready for review. * fix broken links. * Fixed Action node to live under Dialog. * Edit based on revision comments. * Fix broken link to "Action precedence" section. * Dialog Overview - edited based on review feedback. * Added a "Next step" section to each topics. * Reorder Dialog TOC topics * with revisions from paper notes * Update bot-builder-dotnet-quickstart.md Restoring links to the controller & dialog templates that were present in previous documentation * Removing bad metadata (#183) * Conversation designer (#178) * requires (#186) * Added Next step and move Dialogs before Messages in the TOC. * Update referece to te persistCoversatioData flag...it's enabled by default. * Clarify reference to global actions and added new section for customAction to the topic. * Updated Next step to use button instead of link. * Remove "Null response" section based on SteveIckman feedback. * Update section to say "Next steps" for consistencies. * Removing extraneous Additional Resources section * Subscribe to bot events, always show bot online (#189) Slack doc update * Changing author alias (#193) * links to best current samples, User Story 17067 (#185) Fixed sample references. * Second effort for PR181 (#187) Next Steps and Requirement about .NET 4.6 * Groupme screencaps (#191) GroupMe screen changes. * Fixed broken anchor links from table to section in topic. (#195) * Adding NoIndex, NoFollow to metadata (#196) * Removing broken video * Update bot-builder-nodejs-cortana-skill.md Fixed bug reported by PM. Removed "Sign In Card" for Cortana channel link due to a security bug that we recently discovered. * added dotnet scorable dialogs (#180) * added dotnet scorable dialogs * edited links, fixed typos to scorables article * added date/title/header, grammar change * Updated bot-builder-dotnet-scorable-dialogs.md * Update filenames.md * Added entries about the documentation (#206) * Slack review (#204) * Scorable review (#203) * Resolve syncing conflicts from live-sync-work to live (#39) * Release 07-07-2017 (#176) * ISO 639-2 recommends use of the language codes in lower case (#175) * Update bot-builder-dotnet-quickstart.md Restoring links to the controller & dialog templates that were present in previous documentation * Removing bad metadata (#183) * Release 07-14-2017 (#184) * Conversation designer (#178) * Conversation Designer going live (#188) * convert external Twilio links to HTML style target="_blank" to open in new tab. * Secure bot reminder and ngrok command. If you're debugging through Cortana, then the Microsoft App credentials need to specified in both the Bot Framework portal and the Web.config file. I also found that bots always ran on port 3979. And lastly, unless I specified the host header the requests would fail with 400. * convert external links to open in new tab * update external links to open in new tab * Update bot-builder-nodejs-global-handlers.md Added missing comma's in the examples of trigger actions * Fixing link * Revert "Merging upstream into public" This reverts commit ed2438b, reversing changes made to f4200df. * Dotnet form flow updates (#161) * Updated .NET FormFlow articles to add links to sample code on GitHub. * Fixed broken link. * Updated .NET FormFlow articles to move Sample code section. * Fixed broken link. * Update IActivity.xml * Update IActivity.xml Fixing indentation. * Updating summary for ChannelData * Updating IActivity docs with ChannelData remarks * bugfix: domain parameter and log=false for compliance (#164) * fix bug - domain parameter * section link, class definition * document log=off for privacy compliance * fix heading * Change .NET Framework target version (#166) * Adding DirectLine to REST card (#167) * Typo fix * Removing location control from hub * little fixes (#169) Add an optional extended description… * clicking on a speech bubble reveals the JSON data underlying the message. (#171) * Microsoft.Bot.Builder template requires IIS Express; added download link. (#170) * The Microsoft.Bot.Builder template requires IIS Express, so now there's a link where you can download it. * occasional requirement: IIS Express download, a bit hard to find this link so now it's noted near the place where it's (occasionally) needed. * section: dialog-based proactive message - fix broken sample code & link to botadaptor.js file * add back comment with note about session.userData * fix typo * Anchor links (#173) * Promoting questions to H2s for anchor links * Updating title and H1 * Fixing outdated anchor links * VS Community isn't supported by the template * Update dos-and-donts.md * Update style-and-voice.md * Update style-and-voice.md * Fixing link to botadapter.js * section: dialog-based proactive message - fix broken sample code & link to botadaptor.js file * add back comment with note about session.userData * fix typo * ISO 639-2 recommends use of the language codes in lower case (#175) * Update bot-builder-dotnet-quickstart.md Restoring links to the controller & dialog templates that were present in previous documentation * Removing bad metadata (#183) * Conversation designer (#178) * requires (#186) * Dialog next steps (#177) * Added clarification for ListStyle in Prompts.choice * Minor copy edits. * Add reference to Manage state data topic. * Saving progress... * Bind actions to dialog * Types table link to section instead. * Confirm interruptions * Added some more details and made some minor edits. * Update links to reflect new file name for the 'Handle user actions' topic. * Fix broken link. * minor edits to the Actions topic and cross linking. * fixed broken link * Redirecting to the new topic. * Revised content ready for review. * fix broken links. * Fixed Action node to live under Dialog. * Edit based on revision comments. * Fix broken link to "Action precedence" section. * Dialog Overview - edited based on review feedback. * Added a "Next step" section to each topics. * Reorder Dialog TOC topics * with revisions from paper notes * Update bot-builder-dotnet-quickstart.md Restoring links to the controller & dialog templates that were present in previous documentation * Removing bad metadata (#183) * Conversation designer (#178) * requires (#186) * Added Next step and move Dialogs before Messages in the TOC. * Update referece to te persistCoversatioData flag...it's enabled by default. * Clarify reference to global actions and added new section for customAction to the topic. * Updated Next step to use button instead of link. * Remove "Null response" section based on SteveIckman feedback. * Update section to say "Next steps" for consistencies. * Removing extraneous Additional Resources section * Release 7-20-2017 * Added clarification for ListStyle in Prompts.choice * Minor copy edits. * Add reference to Manage state data topic. * Saving progress... * Bind actions to dialog * Types table link to section instead. * Confirm interruptions * Added some more details and made some minor edits. * Update links to reflect new file name for the 'Handle user actions' topic. * Fix broken link. * minor edits to the Actions topic and cross linking. * fixed broken link * Redirecting to the new topic. * Revised content ready for review. * fix broken links. * Fixed Action node to live under Dialog. * Edit based on revision comments. * Fix broken link to "Action precedence" section. * Dialog Overview - edited based on review feedback. * Added a "Next step" section to each topics. * Reorder Dialog TOC topics * with revisions from paper notes * Update bot-builder-dotnet-quickstart.md Restoring links to the controller & dialog templates that were present in previous documentation * Removing bad metadata (#183) * Conversation designer (#178) * requires (#186) * Added Next step and move Dialogs before Messages in the TOC. * Update referece to te persistCoversatioData flag...it's enabled by default. * Clarify reference to global actions and added new section for customAction to the topic. * Updated Next step to use button instead of link. * Remove "Null response" section based on SteveIckman feedback. * Update section to say "Next steps" for consistencies. * Removing extraneous Additional Resources section * Subscribe to bot events, always show bot online (#189) Slack doc update * Changing author alias (#193) * links to best current samples, User Story 17067 (#185) Fixed sample references. * Second effort for PR181 (#187) Next Steps and Requirement about .NET 4.6 * Groupme screencaps (#191) GroupMe screen changes. * Updates to Slack, GroupMe, sample links, next steps (#194) * Fixed broken anchor links from table to section in topic. (#195) * Adding NoIndex, NoFollow to metadata (#196) * Release 7-24-2017 (#197) * Removing broken video * Update bot-builder-nodejs-cortana-skill.md Fixed bug reported by PM. Removed "Sign In Card" for Cortana channel link due to a security bug that we recently discovered. * Update bot-builder-nodejs-cortana-skill.md (#198) Fixed bug reported by PM. Removed "Sign In Card" for Cortana channel link due to a security bug that we recently discovered. * added dotnet scorable dialogs (#180) * added dotnet scorable dialogs * edited links, fixed typos to scorables article * added date/title/header, grammar change * Updated bot-builder-dotnet-scorable-dialogs.md * Update filenames.md * Added entries about the documentation (#206) * Slack review (#204) * Scorable review (#203) * Grammar correction. Whose, not Who's (#33) * Updated to correct version of IISExpress (#35) * Changed AttachmentLayouts to AttachmentLayoutTypes (#38) The types of Attachment Layouts class is called AttachmentLayoutTypes and not AttachmentLayouts. https://docs.botframework.com/en-us/csharp/builder/sdkreference/d7/d87/class_microsoft_1_1_bot_1_1_connector_1_1_attachment_layout_types.html * Update resources-tools-downloads.md (#31) * Update resources-tools-downloads.md Add information for how to install the Visual Studio project templates. * Update resources-tools-downloads.md * Release 08-01-2017 (#207) * Updating next step * Fixing illegal bookmark usage * Fixing build warning in dotnet reference * Fixing build warning in dotnet reference * Staging for fix from nuget release * Cropped out wechat icon. wechat is not supported (#209) * three downloads for one template (#212) * Initialize open publishing repository: https://github.com/MicrosoftDocs/bot-docs-pr of branch live * Initialize open publishing repository: https://github.com/MicrosoftDocs/bot-docs-pr of branch master * Fix for bug# 17564. Add gitter.im, specifically the BotBuilder ROOM (#216) Bug details: https://fuselabs.visualstudio.com/BFDocs/_workitems/edit/17564 * Release 08-03-2017 (#217) * Release 08-04-2017 (#221) * 17561 deploy from local git (#215) * add ms.date metadata (#219) * Fixing search scope * Resolve syncing conflicts from live-sync-work to live (#40) * Delete duplicate section, correct info on how to select ListStyle (#41) * Update bot-design-conversation-flow.md (#42) * Update bot-builder-nodejs-send-suggested-actions.md (#43) * Added ConsoleConnector language and example (#44) * Update bot-builder-nodejs-send-suggested-actions.md * Added ConsoleConnector language and example * Add Teams as channel that supports TextFormat xml (#49) * use numeric prompt for qry of ppl in reservation (#48) * fix formatting for initial npm init invocation (#46) * Update erroneous link to code snippet (#45) * Update live branch 09-08-17 (ABS Fix) * Just a little correction in spelling of visible (#50)
1 parent aff14da commit f6daa3b

15 files changed

+73
-22
lines changed

.openpublishing.publish.config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,4 +138,4 @@
138138
"dotnet/api"
139139
],
140140
"toc_path_need_to_split": "dotnet/api/toc.yml"
141-
}
141+
}

articles/bot-builder-overview-getstarted.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Start building bots with the Bot Framework | Microsoft Docs
3-
description: Get started building powerful bots with the Bot Framework and Bot Builder SDKs.
3+
description: Get started building powerful bots with the Bot Framework and Bot Builder SDK.
44
author: kbrandl
55
ms.author: kibrandl
66
manager: rstand
@@ -9,9 +9,10 @@ ms.prod: bot-framework
99
ms.date: 08/04/2017
1010
---
1111

12+
1213
# Start building bots with the Bot Framework
1314

14-
The Bot Framework includes Bot Builder to give you the tools you need to develop bots. Bot Builder is an open-source SDK with support for .NET, Node.js, and REST. Using Bot Builder, you can get started and have a working bot in just a few minutes.
15+
The Bot Framework includes Bot Builder to help you develop bots. Bot Builder is an open-source SDK with support for .NET, Node.js, and REST. Using Bot Builder, you can get started and have a working bot in just a few minutes.
1516

1617
## Bot Builder SDK for .NET
1718

articles/bot-design-conversation-flow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,4 +70,4 @@ There is no *right* answer to this question, as the best solution will depend up
7070

7171
Managing the user's navigation across dialogs and designing conversation flow in a manner that enables
7272
users to achieve their goals (even in a non-linear fashion) is a fundamental challenge of bot design.
73-
The [next article](~/bot-design-navigation.md) reviews some common pitfalls of poorly designed navigation and discuss strategies for avoiding those traps.
73+
The [next article](~/bot-design-navigation.md) reviews some common pitfalls of poorly designed navigation and discusses strategies for avoiding those traps.

articles/dotnet/bot-builder-dotnet-create-messages.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ These styles are supported when `TextFormat` is set to "xml":
5858
| hyperlink | \<a href="http://www.bing.com"\>bing\</a\> | <a href="http://www.bing.com">bing</a> |
5959

6060
> [!NOTE]
61-
> The `TextFormat` **xml** is supported only by the Skype channel.
61+
> The `TextFormat` **xml** is supported only by the Microsoft Teams and Skype channels.
6262
6363
## Attachments
6464

@@ -146,7 +146,7 @@ The `Speak` property of a message activity can be used to specify the text to be
146146

147147
## Suggested actions
148148

149-
The `SuggestedActions` property of a message activity can be used to present buttons that the user can tap to provide input. Unlike buttons that appear within rich cards (which remain visable and accessible to the user even after being tapped), buttons that appear within the suggested actions pane will disappear after the user makes a selection. For details, see [Add suggested actions to messages](bot-builder-dotnet-add-suggested-actions.md).
149+
The `SuggestedActions` property of a message activity can be used to present buttons that the user can tap to provide input. Unlike buttons that appear within rich cards (which remain visible and accessible to the user even after being tapped), buttons that appear within the suggested actions pane will disappear after the user makes a selection. For details, see [Add suggested actions to messages](bot-builder-dotnet-add-suggested-actions.md).
150150

151151
## Next steps
152152

articles/includes/code/node-getstarted.js

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,15 @@
1+
// <consolebot>
2+
3+
var builder = require('botbuilder');
4+
5+
var connector = new builder.ConsoleConnector().listen();
6+
var bot = new builder.UniversalBot(connector, function (session) {
7+
session.send("You said: %s", session.message.text);
8+
});
9+
// </consolebot>
10+
111
// <echobot>
12+
213
var restify = require('restify');
314
var builder = require('botbuilder');
415

@@ -21,4 +32,4 @@ server.post('/api/messages', connector.listen());
2132
var bot = new builder.UniversalBot(connector, function (session) {
2233
session.send("You said: %s", session.message.text);
2334
});
24-
// </echobot>
35+
// </echobot>

articles/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,7 @@ description:
351351
</div>
352352
</div>
353353
<div class="cardText">
354-
<h3>SDKs and tools</h3>
354+
<h3>SDK and tools</h3>
355355
<p>Get the Bot Framework SDK and tools for building bots.</p>
356356
</div>
357357
</div>

articles/nodejs/bot-builder-nodejs-concepts.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ For an example that demonstrates using these classes, see [Create a bot with the
2727

2828
The Connector also normalizes the messages that the bot sends to channels so that you can develop your bot in a platform-agnostic way. Normalizing a message involves converting it from the Bot Framework’s schema into the channel’s schema. In cases where the channel does not support all aspects of the framework’s schema, the Connector will try to convert the message to a format that the channel supports. For example, if the bot sends a message that contains a card with action buttons to the SMS channel, the Connector may render the card as an image and include the actions as links in the message’s text. The [Channel Inspector][ChannelInspector] is a web tool that shows you how the Connector renders messages on various channels.
2929

30+
The `ChatConnector` requires an API endpoint to be setup within your bot. With the Node.js SDK, this is usually accomplished by installing the `restify` Node.js module. Bots can also be created for the console using the [ConsoleConnector][ConsoleConnector], which does not require an API endpoint.
31+
3032
## Messages
3133

3234
Messages can consist of text to be displayed, text to be spoken, attachments, rich cards, and suggested actions. You use the [session.send][SessionSend] method to send messages in response to a message from the user. Your bot may call `send` as many times as it likes in response to a message from the user. For an example that demonstrates this, see [Respond to user messages][RespondMessages].
@@ -75,6 +77,7 @@ Bot Builder lets you use LUIS to add natural language understanding to your bot
7577
[PersistConversationData]: https://docs.botframework.com/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.iuniversalbotsettings.html#persistconversationdata
7678
[UniversalBot]: https://docs.botframework.com/en-us/node/builder/chat-reference/classes/_botbuilder_d_.universalbot.html
7779
[ChatConnector]: https://docs.botframework.com/en-us/node/builder/chat-reference/classes/_botbuilder_d_.chatconnector.html
80+
[ConsoleConnector]: https://docs.botframework.com/en-us/node/builder/chat-reference/classes/_botbuilder_d_.consoleconnector.html
7881

7982
[ChannelInspector]: https://docs.botframework.com/en-us/channel-inspector/channels/Skype
8083

articles/nodejs/bot-builder-nodejs-dialog-manage-conversation-flow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ var bot = new builder.UniversalBot(connector, [
4444
},
4545
function (session, results) {
4646
session.dialogData.reservationDate = builder.EntityRecognizer.resolveTime([results.response]);
47-
builder.Prompts.text(session, "How many people are in your party?");
47+
builder.Prompts.number(session, "How many people are in your party?");
4848
},
4949
function (session, results) {
5050
session.dialogData.partySize = results.response;

articles/nodejs/bot-builder-nodejs-handle-conversation-events.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,4 +58,4 @@ For trigger actions you can provide an [onInterrupted][onInterrupted] handler to
5858
[SendTyping]: https://docs.botframework.com/en-us/node/builder/chat-reference/classes/_botbuilder_d_.session#sendtyping
5959
[IMessage]: http://docs.botframework.com/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.imessage
6060
[ChatConnector]: https://docs.botframework.com/en-us/node/builder/chat-reference/classes/_botbuilder_d_.chatconnector.html
61-
[session_userData]: https://docs.botframework.com/en-us/node/builder/chat-reference/classes/_botbuilder_d_.session.html#userdata
61+
[session_userData]: https://docs.botframework.com/en-us/node/builder/chat-reference/classes/_botbuilder_d_.session.html#userdata

articles/nodejs/bot-builder-nodejs-quickstart.md

Lines changed: 40 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,33 +28,67 @@ Get started by completing the following prerequisite tasks:
2828
2. Create a folder for your bot.
2929
3. From a command prompt or terminal, navigate to the folder you just created.
3030
4. Run the following **npm** command:
31+
3132
```nodejs
3233
npm init
3334
```
3435

3536
Follow the prompt on the screen to enter information about your bot and npm will create a **package.json** file that contains the information you provided.
3637

3738
## Install the SDK
38-
Next, install the Bot Builder SDK for Node.js and <a href="http://restify.com/" target="_blank">restify</a> by running the following **npm** commands:
39+
Next, install the Bot Builder SDK for Node.js by running the following **npm** command:
3940

4041
```nodejs
4142
npm install --save botbuilder
42-
npm install --save restify
4343
```
4444

45-
Once you have the SDK and Restify in place, you're ready to write your bot.
46-
47-
## Create your bot
45+
Once you have the SDK installed, you are ready to write your first bot.
4846

4947
For your first bot, you will create a bot that simply echoes back any user input. To create your bot, follow these steps:
5048

5149
1. In the folder that you created earlier for your bot, create a new file named **app.js**.
5250
2. Open **app.js** in a text editor or an IDE of your choice. Add the following code to the file:
5351

52+
[!code-javascript[consolebot code sample Node.js](../includes/code/node-getstarted.js#consolebot)]
53+
54+
3. Save the file. Now you are ready to run and test out your bot.
55+
56+
### Start your bot
57+
58+
Navigate to your bot's directory in a console window and start your bot:
59+
60+
```nodejs
61+
node app.js
62+
```
63+
64+
Your bot is now running locally. Try out your bot by typing a few messages in the console window.
65+
You should see that the bot responds to each message you send by echoing back your message prefixed with the text *"You said:"*.
66+
67+
## Install Restify
68+
69+
Console bots are good text-based clients, but in order to use any of the Bot Framework channels (or run your bot in the emulator), your bot will need to run on an API endpoint. Install <a href="http://restify.com/" target="_blank">restify</a> by running the following **npm** command:
70+
71+
```nodejs
72+
npm install --save restify
73+
```
74+
75+
Once you have Restify in place, you're ready to make some changes to your bot.
76+
77+
## Edit your bot
78+
79+
You will need to make some changes to your **app.js** file.
80+
81+
1. Add a line to require the `restify` module.
82+
2. Change the `ConsoleConnector` to a `ChatConnector`.
83+
3. Include your Microsoft App ID and App Password.
84+
4. Have the connector listen on an API endpoint.
85+
5486
[!code-javascript[echobot code sample Node.js](../includes/code/node-getstarted.js#echobot)]
5587

5688
3. Save the file. Now you are ready to run and test out your bot.
5789

90+
Please note that you do not need a Microsoft App ID or App Password to run your bot in the Bot Framework Emulator.
91+
5892
## Test your bot
5993
Next, test your bot by using the [Bot Framework Emulator](../debug-bots-emulator.md) to see it in action. The emulator is a desktop application that lets you test and debug your bot on localhost or running remotely through a tunnel.
6094

@@ -86,4 +120,4 @@ You've successfully created your first bot using the Bot Builder SDK for Node.js
86120
## Next steps
87121

88122
> [!div class="nextstepaction"]
89-
> [Bot Builder SDK for Node.js](bot-builder-nodejs-overview.md)
123+
> [Bot Builder SDK for Node.js](bot-builder-nodejs-overview.md)

0 commit comments

Comments
 (0)