botbuilder package

The ChannelServiceHandlerBase implements API to forward activity to a skill and implements routing ChannelAPI calls from the Skill up through the bot/adapter.

Routes the API calls with the ChannelServiceHandler methods.

An adapter that implements the Bot Framework Protocol and can be hosted in different cloud environmens both public and private.

A class to help with the implementation of the Bot Framework protocol using BotFrameworkAuthentication.

Contains utility methods for creating various event types.

The file transcript store stores transcripts in file system with each activity as a file.

Defines values for handoff event names.

InspectionMiddleware for emulator inspection of runtime Activities and BotState.

InspectionState for use by the InspectionMiddleware for emulator inspection of runtime Activities and BotState.

Constants representing the API path that immediately follows the basePath. These are currently internal but we will re-evaluate making them public, in the future.

Example

RouteConstants.Activities = '/v3/conversations/:conversationId/activities'.

Support the DirectLine speech and telephony channels to ensure the appropriate SSML tags are set on the Activity Speak property.

A Bot Framework Handler for skills.

A BotFrameworkHttpClient specialized for Skills that encapsulates Conversation ID generation.

Extends Error to provide specialized error messages.

An implementation of HttpClient that adds compatibility with streaming connections.

Looks for OAuthCards in Activity attachments and takes action on them

If the activity name is signin/tokenExchange, this middleware will attempt to exchange the token, and deduplicate the incoming call, ensuring only one exchange request is processed. If a user is signed into multiple Teams clients, the Bot could receive a "signin/tokenExchange" from each client. Each token exchange request for a specific user login will have an identical activity.value.id.

Only one of these token exchange requests should be processed by the bot. The others return StatusCodes.PRECONDITION_FAILED. For a distributed bot in production, this requires distributed storage ensuring only one token exchange is processed. This middleware supports CosmosDb storage found in botbuilder-azure, or MemoryStorage for local development.

Adds support for Microsoft Teams specific events and interactions.

Provides utility methods for the events and interactions that occur within Microsoft Teams.

Interface representing an Express Application or a Restify Server.

Abstraction to build connector clients.

Represents a Node.js HTTP Request, including the minimal set of use properties. Compatible with Restify, Express, and Node.js core http.

Represents an Express or Restify request object. This interface supports the framework and is not intended to be called directly for your code.

Represents an Express or Restify response object. This interface supports the framework and is not intended to be called directly for your code.

Validates an Activity and formats the timestamp fields.

Activity helper methods for Teams.

Gets the Team's selected channel id from the current activity.

Gets the Team Id from the current Activity.

Gets the TeamsInfo object from the current Activity.

Gets the TeamsMeetingInfo object from the current Activity.

Gets the TenantInfo object from the current Activity.

Configures the current Activity to generate a notification within Teams.