Skip to content
This repository has been archived by the owner on Sep 20, 2024. It is now read-only.

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
benbrown committed Aug 21, 2020
1 parent 3a25f50 commit 16fdf1b
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion packages/botkit/src/teamsHelpers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export class TeamsBotWorker extends BotWorker {
* Reply to a Teams task module task/fetch or task/submit with a task module response.
* See https://docs.microsoft.com/en-us/microsoftteams/platform/task-modules-and-cards/task-modules/task-modules-bots
* @param message
* @param taskInfo { type: 'continue|message', value: {} }
* @param taskInfo an object in the form {type, value}
*/
public async replyWithTaskInfo(message: BotkitMessage, taskInfo: any) {
if (!taskInfo || taskInfo == {}) {
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/core.md
Original file line number Diff line number Diff line change
Expand Up @@ -547,7 +547,7 @@ const controller = new Botkit({
Several helper extensions are included for using Botkit with Microsoft Teams. Connecting to Teams does not require a customized adapter - Botkit's default adapter does the job. However, to ease the use of advanced features in Teams, Botkit includes several extensions.

* The [TeamsInvokeMiddleware](reference/core.md#teamsinvokemiddleware) is an optional adapter middleware which will cause Botkit to emit specially named events related to Teams "invoke" events. With this middleware enabled, Botkit will emit "task/fetch" and "task/submit" events, rather than plain "invoke" events.
* The BotWorker returned by this adapter includes `bot.teams`, which is an instance of the TeamsInfo helper. Using this, bots can access additional information about Teams. [See Docs]((https://docs.microsoft.com/en-us/javascript/api/botbuilder/teamsinfo?view=botbuilder-ts-latest).
* The BotWorker returned by this adapter includes `bot.teams`, which is an instance of the TeamsInfo helper. Using this, bots can access additional information about Teams. [See Docs](https://docs.microsoft.com/en-us/javascript/api/botbuilder/teamsinfo?view=botbuilder-ts-latest).
* The BotWorker also includes a helper method, `bot.replyWithTaskInfo()` that can be used to respond to Task Module related events. [See Docs](reference/core.md#replywithtaskinfo)

Set up adapter with middleware:
Expand Down
4 changes: 2 additions & 2 deletions packages/docs/index.json
Original file line number Diff line number Diff line change
Expand Up @@ -5754,7 +5754,7 @@
"isExported": true
},
"comment": {
"text": "}\n"
"text": "an object in the form {type, value}\n"
},
"type": {
"type": "intrinsic",
Expand Down Expand Up @@ -6991,7 +6991,7 @@
"isExported": true
},
"comment": {
"text": "}\n"
"text": "an object in the form {type, value}\n"
},
"type": {
"type": "intrinsic",
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/reference/core.md
Original file line number Diff line number Diff line change
Expand Up @@ -842,7 +842,7 @@ See https://docs.microsoft.com/en-us/microsoftteams/platform/task-modules-and-ca
| Argument | Type | description
|--- |--- |---
| message| [BotkitMessage](#BotkitMessage) |
| taskInfo| any | }<br/>
| taskInfo| any | an object in the form {type, value}<br/>
Expand Down

0 comments on commit 16fdf1b

Please sign in to comment.