Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs updates and sample fixes #2968

Merged
merged 5 commits into from
Mar 3, 2020
Merged

Docs updates and sample fixes #2968

merged 5 commits into from
Mar 3, 2020

Conversation

corinagum
Copy link
Contributor

@corinagum corinagum commented Mar 2, 2020

Fixes #2941
Fixes #2921
Fixes #2948

Changelog Entry

Description

  • Add links to LOCALIZATION.md, NOTIFICATION.md, and TELEMETRY.md in docs
  • Add more information on userID, since this is a common pain point
  • Fix Redux sample, which had broken urls

- [ ] Testing Added

@@ -157,20 +180,23 @@ Please note, however:
- Web Chat has no plan to support samples for IE11 (ES5).
- For customers who wish to manually rewrite our other samples to work in IE11, we recommend looking into converting code from ES6+ to ES5 using polyfills and transpilers like [`babel`](https://babeljs.io/docs/en/next/babel-standalone.html).

# How to connect a client app to bot
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

moved to line 44

| `store` | Specify a custom store, e.g. for adding programmatic activity to the bot. |
| `styleOptions` | Object that stores customization values for your styling of Web Chat. For the complete list of (frequently updated) default style options, please see the [defaultStyleOptions.js](https://github.com/microsoft/BotFramework-WebChat/blob/master/packages/component/src/Styles/defaultStyleOptions.js) file. |
| `styleSet` | The non-recommended way of overriding styles. |
| `userID` | Specify a userID. There are two ways to specify the `userID`: in props, or in the token when generating the token call (`createDirectLine()`). If both methods are used to specify the userID, the token userID property will be used, and a `console.warn` will appear during runtime. If the `userID` is provided via props but is prefixed with `'dl'`, e.g. `'dl_1234'`, the value will be thrown and a new `ID` generated. If `userID` is not specified, it will default to a random user ID. Multiple users sharing the same user ID is not recommended; their user state will be shared, which creates a security risk when authenticating. |
Copy link
Contributor Author

@corinagum corinagum Mar 2, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line 25 is where docs changed; everything else is spacing

@corinagum
Copy link
Contributor Author

rerunning CI for test timeouts

@corinagum
Copy link
Contributor Author

Ok I have tests passing in vsts, but it's not updating on GH. I'm squash and merging.

@corinagum corinagum merged commit 0f8f0cb into microsoft:master Mar 3, 2020
@compulim compulim mentioned this pull request Mar 5, 2020
40 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants