Microsoft.Bot.Builder Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Classes
ActivityFactory |
The ActivityFactory to generate text and then uses simple markdown semantics like chatdown to create Activity. |
ActivityHandler |
An implementation of the IBot interface, intended for further subclassing. |
ActivityHandler.InvokeResponseException |
A custom exception for invoke response errors. |
AdapterExtensions |
Defines extension methods for the BotAdapter class. |
AllowedTypesSerializationBinder |
An implementation of the Newtonsoft.Json.Serialization.DefaultSerializationBinder, capable of allowing only desired Types to be serialized and deserialized. |
AutoSaveStateMiddleware |
Middleware to automatically persist state before the end of each turn. |
BotAdapter |
Represents a bot adapter that can connect a bot to a service endpoint. This class is abstract. |
BotAssert |
Provides methods for debugging Bot Builder code. |
BotComponent |
Definition of a BotComponent that allows registration of services, custom actions, memory scopes and adapters. |
BotFrameworkAdapter |
A bot adapter that can connect a bot to a service endpoint. |
BotFrameworkHttpStatusCodeErrorDetectionStrategy |
Bot Framework HTTP Status code error detection strategy. |
BotState |
Defines a state management object and automates the reading and writing of associated state properties to a storage layer. |
BotState.CachedBotState |
Internal cached bot state. |
BotStateSet |
Manages a collection of botState and provides ability to load and save in parallel. |
ChannelServiceHandler |
A class to help with the implementation of the Bot Framework protocol. |
ChannelServiceHandlerBase |
Base class for Bot Framework protocol implementation. |
CloudAdapterBase |
An adapter that implements the Bot Framework Protocol and can be hosted in different cloud environmens both public and private. |
CloudChannelServiceHandler |
A class to help with the implementation of the Bot Framework protocol using BotFrameworkAuthentication. |
ComponentRegistration |
ComponentRegistration is a signature class for discovering assets from components. |
ConversationState |
Defines a state management object for conversation state. |
DelegatingTurnContext<T> |
A TurnContext with a strongly typed Activity property that wraps an untyped inner TurnContext. |
EventFactory |
Contains utility methods for creating various event types. |
FileTranscriptLogger |
FileTranscriptLogger which creates a .transcript file for each conversationId. |
IBotTelemetryClientExtensions |
Extension methods for IBotTelemetryClient. |
InspectionMiddleware |
Middleware to enable debugging the state of a bot. |
InspectionState |
A state management object that automates the reading and writing of the associated state properties to a storage layer. Used by Inspection middleware that enables debugging bot state. |
IntentScore |
Score plus any extra information about an intent. |
InterceptionMiddleware |
Middleware for the interception of activities. |
InvokeResponse |
A tuple class containing an HTTP status code and a JSON-serializable object. The HTTP status code is, in the invoke activity scenario, what will be set in the resulting POST. The body of the resulting POST will be the JSON-serialized content from the Body property. |
InvokeResponse<T> |
A tuple class containing an HTTP status code and a JSON-serializable object. The HTTP status code is, in the invoke activity scenario, what will be set in the resulting POST. The body of the resulting POST will be the JSON-serialized content from the Body property. |
MemoryStorage |
A storage layer that uses an in-memory dictionary. |
MemoryTranscriptStore |
The memory transcript store stores transcripts in volatile memory in a Dictionary. |
MessageFactory |
Contains utility methods for various message types a bot can return. |
MiddlewareSet |
Contains an ordered set of IMiddleware. |
NormalizeMentionsMiddleware |
Middleware to normalize mention Entities from channels that apply <at> markup tags since they don't conform to expected values. Bots that interact with Skype and/or teams should use this middleware if mentions are used. |
NullBotTelemetryClient |
A null bot telemtry client that implements IBotTelemetryClient. |
PagedResult<T> |
Page of results from an enumeration. |
PathUtils |
A utilities class of file path operations. |
PrivateConversationState |
Defines a state management object for private conversation state. |
QueueStorage |
A base class for enqueueing an Activity for later processing. |
RecognizerResult |
Contains recognition results generated by an IRecognizer. |
RecognizerResultExtensions |
Contains helper methods for working with RecognizerResult objects. |
RegisterClassMiddleware<T> |
Middleware for adding an object to or registering a service with the current turn context. |
SetSpeakMiddleware |
Support the DirectLine speech and telephony channels to ensure the appropriate SSML tags are set on the Activity Speak property. |
ShowTypingMiddleware |
When added, this middleware will send typing activities back to the user when a Message activity is received to let them know that the bot has received the message and is working on the response. You can specify a delay in milliseconds before the first typing activity is sent and then a frequency, also in milliseconds which determines how often another typing activity is sent. Typing activities will continue to be sent until your bot sends another message back to the user. |
SkypeMentionNormalizeMiddleware |
Middleware to patch mention Entities from Skype since they don't conform to expected values. Bots that interact with Skype should use this middleware if mentions are used. |
StorageExtensions |
Contains extension methods for IStorage objects. |
StringUtils |
Helper class containing string utility methods. |
TelemetryConstants |
Defines names of common properties for use with a IBotTelemetryClient object. |
TelemetryLoggerConstants |
Defines names of common events for use with a IBotTelemetryClient object. |
TelemetryLoggerMiddleware |
Uses a IBotTelemetryClient object to log incoming, outgoing, updated, or deleted message activities. |
TraceTranscriptLogger |
Represents a transcript logger that writes activities to a Trace object. |
TranscriptInfo |
Represents a copy of a conversation. |
TranscriptLoggerMiddleware |
Middleware for logging incoming and outgoing activities to an ITranscriptStore. |
TurnContext |
Provides context for a turn of a bot. |
TurnContextStateCollection |
Values persisted for the lifetime of the turn as part of the ITurnContext. |
TurnStateConstants |
Constants used in TurnState. |
UserState |
Defines a state management object for user state. |
Interfaces
IBot |
Represents a bot that can operate on incoming activities. |
IBotPageViewTelemetryClient |
Describes a logging client for bot telemetry. |
IBotTelemetryClient |
Describes a logging client for bot telemetry. |
IExtendedUserTokenProvider |
Methods to call methods on the Token Service. |
IMiddleware |
Represents middleware that can operate on incoming activities. |
IPropertyManager |
IPropertyManager defines implementation of a source of named properties. |
IRecognizer |
Interface for Recognizers. |
IRecognizerConvert |
Can convert from a generic recognizer result to a strongly typed one. |
IStatePropertyAccessor<T> |
Interface which defines methods for how you can get data from a property source, such as BotState. |
IStatePropertyInfo |
Metadata about a property, including policy info. |
IStorage |
Defines the interface for a storage layer. |
IStoreItem |
Exposes an ETag for concurrency control. |
ITranscriptLogger |
Transcript logger stores activities for conversations for recall. |
ITranscriptStore |
Represents a store for recording conversations. |
ITurnContext |
Provides context for a turn of a bot. |
ITurnContext<T> |
Provides context for a turn of a bot, where the context's Activity property is strongly typed. |
IUserTokenProvider |
A contract for user token provider classes. |
Enums
Severity |
Defines trace severity levels for use with a IBotTelemetryClient object. |
Delegates
BotCallbackHandler |
The callback delegate for application code. |
DeleteActivityHandler |
A method that can participate in delete activity events for the current turn. |
NextDelegate |
Encapsulates an asynchronous method that calls the next IMiddleware.OnTurnAsync(ITurnContext, NextDelegate, CancellationToken) or IBot.OnTurnAsync(ITurnContext, CancellationToken) method in the middleware pipeline. |
SendActivitiesHandler |
A method that can participate in send activity events for the current turn. |
UpdateActivityHandler |
A method that can participate in update activity events for the current turn. |