Skip to content

Latest commit

 

History

History
1597 lines (1086 loc) · 48 KB

core.md

File metadata and controls

1597 lines (1086 loc) · 48 KB
Raw

Botkit Core Class Reference

← Botkit Documentation ← Class Index

This is a class reference for all the methods exposed by the botkit package.

Classes

Interfaces

Botkit

Create a new instance of Botkit to define the controller for a conversational app. To connect Botkit to a chat platform, pass in a fully configured adapter. If one is not specified, Botkit will expose an adapter for the Microsoft Bot Framework.

To use this class in your application, first install the package:

npm install --save botkit

Then import this and other classes into your code:

const { Botkit } = require('botkit');

This class includes the following methods:

Create a new Botkit()

Parameters

Argument Type Description
config BotkitConfiguration Configuration for this instance of Botkit

Create a new Botkit instance and optionally specify a platform-specific adapter. By default, Botkit will create a BotFrameworkAdapter.

const controller = new Botkit({
     adapter: some_adapter,
     webhook_uri: '/api/messages',
});

controller.on('message', async(bot, message) => {
     // do something!
});

Properties and Accessors

Name Type Description
PATH string The path of the main Botkit SDK, used to generate relative paths
adapter any Any BotBuilder-compatible adapter - defaults to a BotFrameworkAdapter
dialogSet DialogSet A BotBuilder DialogSet that serves as the top level dialog container for the Botkit app
http any A direct reference to the underlying HTTP server object
storage Storage a BotBuilder storage driver - defaults to MemoryStorage
version string The current version of Botkit Core
webserver any An Express webserver
plugins Access plugin extension methods.
After a plugin calls controller.addPluginExtension('foo', extension_methods), the extension will then be available at
controller.plugins.foo

Botkit Class Methods

addDep()

(For use by Botkit plugins only) - Add a dependency to Botkit's bootup process that must be marked as completed using completeDep(). Botkit's controller.ready() function will not fire until all dependencies have been marked complete.

Parameters

Argument Type description
name string The name of the dependency that is being loaded.

For example, a plugin that needs to do an asynchronous task before Botkit proceeds might do:

controller.addDep('my_async_plugin');
somethingAsync().then(function() {
 controller.completeDep('my_async_plugin');
});

addDialog()

Add a dialog to the bot, making it accessible via bot.beginDialog(dialog_id)

Parameters

Argument Type description
dialog Dialog A dialog to be added to the bot's dialog set
 
// Create a dialog -- `BotkitConversation` is just one way to create a dialog
const my_dialog = new BotkitConversation('my_dialog', controller);
my_dialog.say('Hello');

// Add the dialog to the Botkit controller
controller.addDialog(my_dialog);

// Later on, trigger the dialog into action!
controller.on('message', async(bot, message) => {
     await bot.beginDialog('my_dialog');
});

addPluginExtension()

(Plugins only) Extend Botkit's controller with new functionality and make it available globally via the controller object.

Parameters

Argument Type description
name string name of plugin
extension any an object containing methods
 
// define the extension interface
let extension = {
        stuff: () => { return 'stuff' }
}

// register the extension
controller.addPluginExtension('foo', extension);

// call extension
controller.plugins.foo.stuff();

afterDialog()

Bind a handler to the end of a dialog. NOTE: bot worker cannot use bot.reply(), must use bot.send()

Parameters

Argument Type description
dialog the dialog object or the id of the dialog
handler BotkitHandler a handler function in the form async(bot, dialog_results) => {}

Learn more about handling end-of-conversation

completeDep()

(For use by plugins only) - Mark a bootup dependency as loaded and ready to use Botkit's controller.ready() function will not fire until all dependencies have been marked complete.

Parameters

Argument Type description
name string The name of the dependency that has completed loading.

getConfig()

Get a value from the configuration.

Parameters

Argument Type description
key (optional) string The name of a value stored in the configuration

Returns

The value stored in the configuration (or null if absent)

For example:

// get entire config object
let config = controller.getConfig();

// get a specific value from the config
let webhook_uri = controller.getConfig('webhook_uri');

getLocalView()

Convert a local path from a plugin folder to a full path relative to the webserver's main views folder. Allows a plugin to bundle views/layouts and make them available to the webserver's renderer.

Parameters

Argument Type description
path_to_view any something like path.join(__dirname,'views')

handleTurn()

Accepts the result of a BotBuilder adapter's processActivity() method and processes it into a Botkit-style message and BotWorker instance which is then used to test for triggers and emit events. NOTE: This method should only be used in custom adapters that receive messages through mechanisms other than the main webhook endpoint (such as those received via websocket, for example)

Parameters

Argument Type description
turnContext TurnContext a TurnContext representing an incoming message, typically created by an adapter's processActivity() method.

hears()

Instruct your bot to listen for a pattern, and do something when that pattern is heard. Patterns will be "heard" only if the message is not already handled by an in-progress dialog. To "hear" patterns before dialogs are processed, use controller.interrupts() instead.

Parameters

Argument Type description
patterns One or more string, regular expression, or test function
events A list of event types that should be evaluated for the given patterns
handler BotkitHandler a function that will be called should the pattern be matched

For example:

// listen for a simple keyword
controller.hears('hello','message', async(bot, message) => {
 await bot.reply(message,'I heard you say hello.');
});

// listen for a regular expression
controller.hears(new RegExp(/^[A-Z\s]+$/), 'message', async(bot, message) => {
 await bot.reply(message,'I heard a message IN ALL CAPS.');
});

// listen using a function
controller.hears(async (message) => { return (message.intent === 'hello') }, 'message', async(bot, message) => {
 await bot.reply(message,'This message matches the hello intent.');
});

interrupts()

Instruct your bot to listen for a pattern, and do something when that pattern is heard. Interruptions work just like "hears" triggers, but fire before the dialog system is engaged, and thus handlers will interrupt the normal flow of messages through the processing pipeline.

Parameters

Argument Type description
patterns One or more string, regular expression, or test function
events A list of event types that should be evaluated for the given patterns
handler BotkitHandler a function that will be called should the pattern be matched
 
controller.interrupts('help','message', async(bot, message) => {

 await bot.reply(message,'Before anything else, you need some help!')

});

loadModule()

Load a Botkit feature module

Parameters

Argument Type description
p string path to module file

loadModules()

Load all Botkit feature modules located in a given folder.

Parameters

Argument Type description
p string path to a folder of module files
exts the extensions that you would like to load (default: ['.js'])
 
controller.ready(() => {

 // load all modules from sub-folder features/
 controller.loadModules('./features');

});

on()

Bind a handler function to one or more events.

Parameters

Argument Type description
events One or more event names
handler BotkitHandler a handler function that will fire whenever one of the named events is received.
 
controller.on('conversationUpdate', async(bot, message) => {

 await bot.reply(message,'I received a conversationUpdate event.');

});

publicFolder()

Expose a folder to the web as a set of static files. Useful for plugins that need to bundle additional assets!

Parameters

Argument Type description
alias any the public alias ie /myfiles
path any the actual path something like __dirname + '/public'
 
// make content of the local public folder available at http://MYBOTURL/public/myplugin
controller.publicFolder('/public/myplugin', __dirname + '/public);

ready()

Use controller.ready() to wrap any calls that require components loaded during the bootup process. This will ensure that the calls will not be made until all of the components have successfully been initialized.

Parameters

Argument Type description
handler A function to run when Botkit is booted and ready to run.

For example:

controller.ready(() => {

  controller.loadModules(__dirname + '/features');

});

saveState()

Save the current conversation state pertaining to a given BotWorker's activities. Note: this is normally called internally and is only required when state changes happen outside of the normal processing flow.

Parameters

Argument Type description
bot BotWorker a BotWorker instance created using controller.spawn()

shutdown()

Shutdown the webserver and prepare to terminate the app. Causes Botkit to first emit a special shutdown event, process any bound handlers, and then finally terminate the webserver. Bind any necessary cleanup helpers to the shutdown event - for example, close the connection to mongo.

await controller.shutdown();
controller.on('shutdown', async() => {
     console.log('Bot is shutting down!');
});

spawn()

Create a platform-specific BotWorker instance that can be used to respond to messages or generate new outbound messages. The spawned bot contains all information required to process outbound messages and handle dialog state, and may also contain extensions for handling platform-specific events or activities.

Parameters

Argument Type description
config (optional) any Preferably receives a DialogContext, though can also receive a TurnContext. If excluded, must call bot.changeContext(reference) before calling any other method.
custom_adapter (optional) BotAdapter

trigger()

Trigger an event to be fired. This will cause any bound handlers to be executed. Note: This is normally used internally, but can be used to emit custom events.

Parameters

Argument Type description
event string the name of the event
bot (optional) BotWorker a BotWorker instance created using controller.spawn()
message (optional) BotkitMessage An incoming message or event
 
// fire a custom event
controller.trigger('my_custom_event', bot, message);

// handle the custom event
controller.on('my_custom_event', async(bot, message) => {
 //... do something
});

usePlugin()

Load a plugin module and bind all included middlewares to their respective endpoints.

Parameters

Argument Type description
plugin_or_function A plugin module in the form of function(botkit) {...} that returns {name, middlewares, init} or an object in the same form.

BotkitBotFrameworkAdapter

This class extends the BotFrameworkAdapter with a few additional features to support Microsoft Teams.

  • Changes userAgent to reflect Botkit instead of BotBuilder
  • Adds getChannels() (MS Teams)
  • Adds middleware for adjusting location of tenant id field (MS Teams)

To use this class in your application, first install the package:

npm install --save botkit

Then import this and other classes into your code:

const { BotkitBotFrameworkAdapter } = require('botkit');

This class includes the following methods:

Properties and Accessors

Name Type Description
botkit_worker TeamsBotWorker

BotkitBotFrameworkAdapter Class Methods

getChannels()

Get the list of channels in a MS Teams team. Can only be called with a TurnContext that originated in a team conversation - 1:1 conversations happen outside a team and thus do not contain the required information to call this API.

Parameters

Argument Type description
context TurnContext A TurnContext object representing a message or event from a user in Teams

Returns

an array of channels in the format [{name: string, id: string}]

TeamsBotWorker

This is a specialized version of Botkit's core BotWorker class that includes additional methods for interacting with Microsoft Teams. It includes all functionality from the base class, as well as the extension methods below. This BotWorker is used with the built-in Bot Framework adapter.

To use this class in your application, first install the package:

npm install --save botkit

Then import this and other classes into your code:

const { TeamsBotWorker } = require('botkit');

This class includes the following methods:

Properties and Accessors

Name Type Description
teams TeamsInfo Grants access to the TeamsInfo helper class
See: https://docs.microsoft.com/en-us/javascript/api/botbuilder/teamsinfo?view=botbuilder-ts-latest

TeamsBotWorker Class Methods

replyWithTaskInfo()

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

Parameters

Argument Type description
message BotkitMessage
taskInfo any an object in the form {type, value}

BotWorker

A base class for a bot instance, an object that contains the information and functionality for taking action in response to an incoming message. Note that adapters are likely to extend this class with additional platform-specific methods - refer to the adapter documentation for these extensions.

To use this class in your application, first install the package:

npm install --save botkit

Then import this and other classes into your code:

const { BotWorker } = require('botkit');

This class includes the following methods:

Create a new BotWorker()

Parameters

Argument Type Description
controller Botkit A pointer to the main Botkit controller
config any An object typically containing { dialogContext, reference, context, activity }

Create a new BotWorker instance. Do not call this directly - instead, use controller.spawn().

Properties and Accessors

Name Type Description
controller Get a reference to the main Botkit controller.

BotWorker Class Methods

beginDialog()

Begin a pre-defined dialog by specifying its id. The dialog will be started in the same context (same user, same channel) in which the original incoming message was received. See "Using Dialogs" in the core documentation.

Parameters

Argument Type description
id string id of dialog
options (optional) any object containing options to be passed into the dialog
 
controller.hears('hello', 'message', async(bot, message) => {
     await bot.beginDialog(GREETINGS_DIALOG);
});

cancelAllDialogs()

Cancel any and all active dialogs for the current user/context.

changeContext()

Alter the context in which a bot instance will send messages. Use this method to create or adjust a bot instance so that it can send messages to a predefined user/channel combination.

Parameters

Argument Type description
reference Partial<ConversationReference> A ConversationReference, most likely captured from an incoming message and stored for use in proactive messaging scenarios.
 
// get the reference field and store it.
const saved_reference = message.reference;

// later on...
let bot = await controller.spawn();
bot.changeContext(saved_reference);
bot.say('Hello!');

ensureMessageFormat()

Take a crudely-formed Botkit message with any sort of field (may just be a string, may be a partial message object) and map it into a beautiful BotFramework Activity. Any fields not found in the Activity definition will be moved to activity.channelData.

Parameters

Argument Type description
message

Returns

a properly formed Activity object

getActiveDialog()

Get a reference to the active dialog

Returns

a reference to the active dialog or undefined if no dialog is active

getConfig()

Get a value from the BotWorker's configuration.

Parameters

Argument Type description
key (optional) string The name of a value stored in the configuration

Returns

The value stored in the configuration (or null if absent)

let original_context = bot.getConfig('context');
await original_context.sendActivity('send directly using the adapter instead of Botkit');

hasActiveDialog()

Check if any dialog is active or not

Returns

true if there is an active dialog, otherwise false

httpBody()

Set the http response body for this turn. Use this to define the response value when the platform requires a synchronous response to the incoming webhook.

Parameters

Argument Type description
body any (any) a value that will be returned as the http response body

Example handling of a /slash command from Slack:

controller.on('slash_command', async(bot, message) => {
 bot.httpBody('This is a reply to the slash command.');
})

httpStatus()

Set the http response status code for this turn

Parameters

Argument Type description
status number a valid http status code like 200 202 301 500 etc
 
controller.on('event', async(bot, message) => {
  // respond with a 500 error code for some reason!
  bot.httpStatus(500);
});

isDialogActive()

Check to see if a given dialog is currently active in the stack

Parameters

Argument Type description
id string The id of a dialog to look for in the dialog stack

Returns

true if dialog with id is located anywhere in the dialog stack

replaceDialog()

Replace any active dialogs with a new a pre-defined dialog by specifying its id. The dialog will be started in the same context (same user, same channel) in which the original incoming message was received. See "Using Dialogs" in the core documentation.

Parameters

Argument Type description
id string id of dialog
options (optional) any object containing options to be passed into the dialog
 
controller.hears('hello', 'message', async(bot, message) => {
     await bot.replaceDialog(GREETINGS_DIALOG);
});

reply()

Reply to an incoming message. Message will be sent using the context of the source message, which may in some cases be different than the context used to spawn the bot.

Parameters

Argument Type description
src Partial<BotkitMessage> An incoming message, usually passed in to a handler function
resp A string containing the text of a reply, or more fully formed message object

Returns

Return value will contain the results of the send action, typically `{id: <id of message>}`

Note that like bot.say(), reply() can take a string or a message object.

controller.on('event', async(bot, message) => {

 await bot.reply(message, 'I received an event and am replying to it.');

});

say()

Send a message using whatever context the bot was spawned in or set using changeContext() -- or more likely, one of the platform-specific helpers like startPrivateConversation() (Slack), startConversationWithUser() (Twilio SMS), and startConversationWithUser() (Facebook Messenger). Be sure to check the platform documentation for others - most adapters include at least one.

Parameters

Argument Type description
message A string containing the text of a reply, or more fully formed message object

Returns

Return value will contain the results of the send action, typically `{id: <id of message>}`

Simple use in event handler (acts the same as bot.reply)

controller.on('event', async(bot, message) => {

 await bot.say('I received an event!');

});

Use with a freshly spawned bot and bot.changeContext:

let bot = controller.spawn(OPTIONS);
bot.changeContext(REFERENCE);
bot.say('ALERT! I have some news.');

Use with multi-field message object:

controller.on('event', async(bot, message) => {
     bot.say({
         text: 'I heard an event',
         attachments: [
             title: message.type,
             text: `The message was of type ${ message.type }`,
             // ...
         ]
     });
});

startConversationWithUser()

Parameters

Argument Type description
reference any

BotkitConversation

An extension on the BotBuilder Dialog Class that provides a Botkit-friendly interface for defining and interacting with multi-message dialogs. Dialogs can be constructed using say(), ask() and other helper methods.

// define the structure of your dialog...
const convo = new BotkitConversation('foo', controller);
convo.say('Hello!');
convo.ask('What is your name?', async(answer, convo, bot) => {
     await bot.say('Your name is ' + answer);
});
controller.dialogSet.add(convo);

// later on, trigger this dialog by its id
controller.on('event', async(bot, message) => {
 await bot.beginDialog('foo');
})

To use this class in your application, first install the package:

npm install --save botkit

Then import this and other classes into your code:

const { BotkitConversation } = require('botkit');

This class includes the following methods:

Create a new BotkitConversation()

Parameters

Argument Type Description
dialogId string A unique identifier for this dialog, used to later trigger this dialog
controller Botkit A pointer to the main Botkit controller

Create a new BotkitConversation object

Properties and Accessors

Name Type Description
script any A map of every message in the dialog, broken into threads

BotkitConversation Class Methods

addAction()

An an action to the conversation timeline. This can be used to go to switch threads or end the dialog.

Parameters

Argument Type description
action string An action or thread name
thread_name string The name of the thread to which this action is added. Defaults to default

When provided the name of another thread in the conversation, this will cause the bot to go immediately to that thread.

Otherwise, use one of the following keywords:

  • stop
  • repeat
  • complete
  • timeout

Learn more about building conversations →

// go to a thread called "next_thread"
convo.addAction('next_thread');

// end the conversation and mark as successful
convo.addAction('complete');

addChildDialog()

Cause the dialog to call a child dialog, wait for it to complete, then store the results in a variable and resume the parent dialog. Use this to combine multiple dialogs into bigger interactions.

Parameters

Argument Type description
dialog_id string the id of another dialog
key_name (optional) string the variable name in which to store the results of the child dialog. if not provided, defaults to dialog_id.
thread_name string the name of a thread to which this call should be added. defaults to 'default'

Learn more about building conversations →

// define a profile collection dialog
let profileDialog = new BotkitConversation('PROFILE_DIALOG', controller);
profileDialog.ask('What is your name?', async(res, convo, bot) => {}, {key: 'name'});
profileDialog.ask('What is your age?', async(res, convo, bot) => {}, {key: 'age'});
profileDialog.ask('What is your location?', async(res, convo, bot) => {}, {key: 'location'});
controller.addDialog(profileDialog);

let onboard = new BotkitConversation('ONBOARDING', controller);
onboard.say('Hello! It is time to collect your profile data.');
onboard.addChildDialog('PROFILE_DIALOG', 'profile');
onboard.say('Hello, {{vars.profile.name}}! Onboarding is complete.');

addGotoDialog()

Cause the current dialog to handoff to another dialog. The parent dialog will not resume when the child dialog completes. However, the afterDialog event will not fire for the parent dialog until all child dialogs complete. Use this to combine multiple dialogs into bigger interactions.

Parameters

Argument Type description
dialog_id string the id of another dialog
thread_name string the name of a thread to which this call should be added. defaults to 'default'

Learn more about building conversations →

let parent = new BotkitConversation('parent', controller);
let child = new BotkitConversation('child', controller);
parent.say('Moving on....');
parent.addGotoDialog('child');

addMessage()

Add a message template to a specific thread. Messages added with say() and addMessage() will be sent one after another without a pause.

Parameters

Argument Type description
message Message template to be sent
thread_name string Name of thread to which message will be added

Learn more about building conversations →

let conversation = new BotkitConversation('welcome', controller);
conversation.say('Hello! Welcome to my app.');
conversation.say('Let us get started...');
// pass in a message with an action that will cause gotoThread to be called...
conversation.addAction('continuation');

conversation.addMessage('This is a different thread completely', 'continuation');

addQuestion()

Identical to ask(), but accepts the name of a thread to which the question is added.

Parameters

Argument Type description
message A message that will be used as the prompt
handlers One or more handler functions defining possible conditional actions based on the response to the question
key Name of variable to store response in.
thread_name string Name of thread to which message will be added

Learn more about building conversations →

after()

Bind a function to run after the dialog has completed. The first parameter to the handler will include a hash of all variables set and values collected from the user during the conversation. The second parameter to the handler is a BotWorker object that can be used to start new dialogs or take other actions.

Parameters

Argument Type description
handler in the form async(results, bot) { ... }

Learn more about handling end of conversation

let convo = new BotkitConversation(MY_CONVO, controller);
convo.ask('What is your name?', [], 'name');
convo.ask('What is your age?', [], 'age');
convo.ask('What is your favorite color?', [], 'color');
convo.after(async(results, bot) => {

     // handle results.name, results.age, results.color

});
controller.addDialog(convo);

ask()

Add a question to the default thread. In addition to a message template, receives either a single handler function to call when an answer is provided, or an array of handlers paired with trigger patterns. When providing multiple conditions to test, developers may also provide a handler marked as the default choice.

Parameters

Argument Type description
message a message that will be used as the prompt
handlers one or more handler functions defining possible conditional actions based on the response to the question.
key name of variable to store response in.

Learn more about building conversations →

// ask a question, handle the response with a function
convo.ask('What is your name?', async(response, convo, bot, full_message) => {
 await bot.say('Oh your name is ' + response);
}, {key: 'name'});

// ask a question, evaluate answer, take conditional action based on response
convo.ask('Do you want to eat a taco?', [
 {
     pattern: 'yes',
     type: 'string',
     handler: async(response_text, convo, bot, full_message) => {
         return await convo.gotoThread('yes_taco');
     }
 },
 {
     pattern: 'no',
     type: 'string',
     handler: async(response_text, convo, bot, full_message) => {
         return await convo.gotoThread('no_taco');
     }
  },
  {
      default: true,
      handler: async(response_text, convo, bot, full_message) => {
          await bot.say('I do not understand your response!');
          // start over!
          return await convo.repeat();
      }
  }
], {key: 'tacos'});

before()

Register a handler function that will fire before a given thread begins. Use this hook to set variables, call APIs, or change the flow of the conversation using convo.gotoThread

Parameters

Argument Type description
thread_name string A valid thread defined in this conversation
handler A handler function in the form async(convo, bot) => { ... }
 
convo.addMessage('This is the foo thread: var == {{vars.foo}}', 'foo');
convo.before('foo', async(convo, bot) => {
 // set a variable here that can be used in the message template
 convo.setVar('foo','THIS IS FOO');

});

onChange()

Bind a function to run whenever a user answers a specific question. Can be used to validate input and take conditional actions.

Parameters

Argument Type description
variable string name of the variable to watch for changes
handler a handler function that will fire whenever a user's response is used to change the value of the watched variable
 
convo.ask('What is your name?', [], 'name');
convo.onChange('name', async(response, convo, bot) => {

 // user changed their name!
 // do something...

});

say()

Add a non-interactive message to the default thread. Messages added with say() and addMessage() will not wait for a response, will be sent one after another without a pause.

Parameters

Argument Type description
message Message template to be sent

Learn more about building conversations →

let conversation = new BotkitConversation('welcome', controller);
conversation.say('Hello! Welcome to my app.');
conversation.say('Let us get started...');

BotkitDialogWrapper

This class is used to provide easy access to common actions taken on active BotkitConversation instances. These objects are passed into handlers bound to BotkitConversations using .before .onChange and conditional handler functions passed to .ask and .addQuestion Grants access to convo.vars convo.gotoThread() convo.setVar() and convo.repeat().

To use this class in your application, first install the package:

npm install --save botkit

Then import this and other classes into your code:

const { BotkitDialogWrapper } = require('botkit');

This class includes the following methods:

Create a new BotkitDialogWrapper()

Parameters

Argument Type Description
dc DialogContext
step BotkitConversationStep

Properties and Accessors

Name Type Description
vars An object containing variables and user responses from this conversation.

BotkitDialogWrapper Class Methods

gotoThread()

Jump immediately to the first message in a different thread.

Parameters

Argument Type description
thread string Name of a thread

repeat()

Repeat the last message sent on the next turn.

setVar()

Set the value of a variable that will be available to messages in the conversation. Equivalent to convo.vars.key = val; Results in {{vars.key}} being replaced with the value in val.

Parameters

Argument Type description
key any the name of the variable
val any the value for the variable

stop()

Stop the dialog.

BotkitTestClient

A client for testing dialogs in isolation.

To use this class in your application, first install the package:

npm install --save botkit

Then import this and other classes into your code:

const { BotkitTestClient } = require('botkit');

This class includes the following methods:

Create a new BotkitTestClient()

Parameters

Argument Type Description
channelId string The channelId to be used for the test.
Use 'emulator' or 'test' if you are uncertain of the channel you are targeting.
Otherwise, it is recommended that you use the id for the channel(s) your bot will be using and write a test case for each channel.
bot Botkit (Required) The Botkit bot that has the skill to test.
dialogToTest (Required) The identifier of the skill to test in the bot.
initialDialogOptions any (Optional) additional argument(s) to pass to the dialog being started.
middlewares (Optional) a stack of middleware to be run when testing
conversationState ConversationState (Optional) A ConversationState instance to use in the test client

Create a BotkitTestClient to test a dialog without having to create a full-fledged adapter.

let client = new BotkitTestClient('test', bot, MY_DIALOG, MY_OPTIONS);
let reply = await client.sendActivity('first message');
assert.strictEqual(reply.text, 'first reply', 'reply failed');

Create a new BotkitTestClient()

Parameters

Argument Type Description
testAdapter TestAdapter
bot Botkit (Required) The Botkit bot that has the skill to test.
dialogToTest (Required) The identifier of the skill to test in the bot.
initialDialogOptions any (Optional) additional argument(s) to pass to the dialog being started.
middlewares (Optional) a stack of middleware to be run when testing
conversationState ConversationState (Optional) A ConversationState instance to use in the test client

Create a BotkitTestClient to test a dialog without having to create a full-fledged adapter.

let client = new BotkitTestClient('test', bot, MY_DIALOG, MY_OPTIONS);
let reply = await client.sendActivity('first message');
assert.strictEqual(reply.text, 'first reply', 'reply failed');

Properties and Accessors

Name Type Description
conversationState ConversationState
dialogTurnResult DialogTurnResult

BotkitTestClient Class Methods

getNextReply()

Get the next reply waiting to be delivered (if one exists)

sendActivity()

Send an activity into the dialog.

Parameters

Argument Type description
activity an activity potentially with text

javascript<br/>DialogTest.send('hello').assertReply('hello yourself').then(done);<br/>

Returns

a TestFlow that can be used to assert replies etc

TeamsInvokeMiddleware

When used, causes Botkit to emit special events for teams "invokes" Based on https://github.com/microsoft/botbuilder-js/blob/master/libraries/botbuilder/src/teamsActivityHandler.ts This allows Botkit bots to respond directly to task/fetch or task/submit events, as an example. To use this, bind it to the adapter before creating the Botkit controller:

const Botkit = new Botkit({...});
botkit.adapter.use(new TeamsInvokeMiddleware());

// can bind directly to task/fetch, task/submit and other invoke types used by teams
controller.on('task/fetch', async(bot, message) => {
   await bot.replyWithTaskInfo(message, taskInfo);
});

To use this class in your application, first install the package:

npm install --save botkit

Then import this and other classes into your code:

const { TeamsInvokeMiddleware } = require('botkit');

This class includes the following methods:

TeamsInvokeMiddleware Class Methods

onTurn()

Not for direct use - implements the MiddlewareSet's required onTurn function used to process the event

Parameters

Argument Type description
context TurnContext
next

Interface BotkitConfiguration

Defines the options used when instantiating Botkit to create the main app controller with new Botkit(options)

Fields

Name Type Description
adapter any A fully configured BotBuilder Adapter, such as botbuilder-adapter-slack or botbuilder-adapter-web
The adapter is responsible for translating platform-specific messages into the format understood by Botkit and BotBuilder.
adapterConfig If using the BotFramework service, options included in adapterConfig will be passed to the new Adapter when created internally.
See BotFrameworkAdapterSettings.
dialogStateProperty string Name of the dialogState property in the ConversationState that will be used to automatically track the dialog state. Defaults to dialogState.
disable_console boolean Disable messages normally sent to the console during startup.
disable_webserver boolean Disable webserver. If true, Botkit will not create a webserver or expose any webhook endpoints automatically. Defaults to false.
For an example of how to use your own Express, see this sample code.

| jsonLimit | string | Limit of the size of incoming JSON payloads parsed by the Express bodyParser. Defaults to '100kb'
| storage | Storage | A Storage interface compatible with this specification
Defaults to the ephemeral MemoryStorage implementation.
| urlEncodedLimit | string | Limit of the size of incoming URL encoded payloads parsed by the Express bodyParser. Defaults to '100kb'
| webhook_uri | string | Path used to create incoming webhook URI. Defaults to /api/messages
| webserver | any | An instance of Express used to define web endpoints. If not specified, one will be created internally.
Note: only use your own Express if you absolutely must for some reason. Otherwise, use controller.webserver
| webserver_middlewares | | An array of middlewares that will be automatically bound to the webserver.
Should be in the form (req, res, next) => {}

Interface BotkitConversationStep

Fields

Name Type Description
index number The number pointing to the current message in the current thread in this dialog's script
next A function to call when the step is completed.
options any A pointer to any options passed into the dialog when it began
reason DialogReason The reason for this step being called
result any The results of the previous turn
state any A pointer to the current dialog state
thread string The name of the current thread
threadLength number The length of the current thread
values any A pointer directly to state.values

Interface BotkitHandler

A handler function passed into hears() or on() that receives a BotWorker instance and a BotkitMessage. Should be defined as an async function and/or return a Promise.

The form of these handlers should be:

async (bot, message) => {
// stuff.
}

For example:

controller.on('event', async(bot, message) => {
 // do somethign using bot and message like...
 await bot.reply(message,'Received an event.');
});

Interface BotkitMessage

Defines the expected form of a message or event object being handled by Botkit. Will also contain any additional fields including in the incoming payload.

Fields

Name Type Description
channel string Unique identifier of the room/channel/space in which the message was sent. Typically contains the platform specific designator for that channel.
incoming_message Activity The original incoming BotBuilder Activity object as created by the adapter.
reference ConversationReference A full ConversationReference object that defines the address of the message and all information necessary to send messages back to the originating location.
Can be stored for later use, and used with bot.changeContext() to send proactive messages.
text string Text of the message sent by the user (or primary value in case of button click)
type string The type of event, in most cases defined by the messaging channel or adapter
user string Unique identifier of user who sent the message. Typically contains the platform specific user id.
value string Any value field received from the platform

Interface BotkitPlugin

An interface for plugins that can contain multiple middlewares as well as an init function.

Fields

Name Type Description
init
middlewares
name string