Microsoft.Bot.Builder.Dialogs 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
| ActivityPrompt |
Defines the core behavior of a prompt dialog that waits for an activity to be received. |
| Address |
The key that minimally and completely identifies a bot's conversation with a user on a channel. |
| AttachmentPrompt |
Prompts a user to upload attachments, like images. |
| Awaitable | |
| AwaitableFromItem<T> |
Creates a IAwaitable<T> from item passed to constructor. |
| AwaitableFromSource<TSource,TItem> |
Creates a IAwaitable<T> from source passed to constructor. |
| BeginSkillDialogOptions |
A class with dialog arguments for a SkillDialog. |
| Case<T,R> |
The default implementation of ICase<T,R>. |
| Chain |
A fluent, chainable interface for IDialogs. |
| Chain.WhereCanceledException |
The exception that is thrown when the where is canceled. |
| ChannelCapability | |
| ChannelCapabilityEx | |
| ChannelIds | |
| ChoicePrompt |
Prompts a user to select from a list of choices. |
| ChronoDuration | |
| ChronoDurationResolution | |
| CommandDialog<T>.Command |
A single command. |
| CommandDialog<T> |
Dialog that dispatches based on a regex matching input. |
| ComponentDialog |
A Dialog that is composed of other dialogs. |
| ConfirmPrompt |
Prompts a user to confirm something with a yes/no response. |
| Conversation |
The top level composition root for the SDK. |
| ConversationAddressComparer |
Compare two Address instances for equality, excluding the user information. |
| DateTimePrompt |
Prompts a user for a date-time value. |
| DateTimeResolution |
A date-time value, as recognized by the DateTimePrompt. |
| DefaultCase<T,R> |
The default case for switch. ICase<T,R> |
| DeleteProfileScorable | |
| Dialog |
Base class for all dialogs. |
| DialogContainer |
A container for a set of Dialogs. |
| DialogContext |
Provides context for the current state of the dialog stack. |
| DialogContextPath |
Defines path for available dialog contexts. |
| DialogContextVisibleState |
Defines the shape of the state object returned by calling DialogContext.State.ToJson(). |
| DialogEvent |
Represents an event related to the "lifecycle" of the dialog. |
| DialogEvents |
Represents the events related to the "lifecycle" of the dialog. |
| DialogExtensions |
Provides extension methods for Dialog and derived classes. |
| DialogInstance |
Contains state information associated with a Dialog on a dialog stack. |
| DialogManager |
Class which runs the dialog system. |
| DialogManagerAdapter |
Represents a dialog manager adapter that can connect a dialog manager to a service endpoint. |
| DialogManagerResult |
Represents the result of the Dialog Manager turn. |
| DialogPath |
Defines path for available dialogs. |
| DialogsBotComponent |
Bot component for bot Dialogs. |
| DialogsComponentRegistration |
Makes Dialogs components available to the system registering functionality. |
| DialogSet |
A collection of Dialog objects that can all call each other. |
| DialogStackException |
The root of the exception hierarchy related to IDialogStack . |
| DialogState |
Contains state information for the dialog stack. |
| DialogTurnResult |
Result returned to the caller of one of the various stack manipulation methods. |
| DispatchDialog |
A dialog specialized to dispatch an IScorable. |
| DispatchDialog<TResult> |
A dialog specialized to dispatch an IScorable. |
| EndConversationEvent |
This event represents the end of the conversation. It is initiated by EndConversation(IDialogContext, String) and propagates as an event in the stack scorable process to allow interception. |
| Extensions |
Helper methods. |
| GetTokenDialog |
A Dialog to rerieve a user token for a configured OAuth connection This Dialog will first attempt to rerieve the user token from the Azure Bot Service If the Azure Bot Service does not already have a token, the GetTokenDialog will send the user an OAuthCard. The GetTokenDialog will then wait for either the user to come back, or for the user to send a validation code. The Dialog will attempt to exchange whatever response is sent for the user token. If successful, the dialog will return the token and otherwise will retry the specified number of times. |
| GetTokenResponse |
Result object from the GetTokenDialog If the GetToken action is successful in retrieving a user token, the GetTokenDialog will be populated with the Token property If the GetToken action is unsuccessful in retrieving a user token, the GetTokenDialog will be populated with the NonTokenResponse property |
| InvalidIntentHandlerException |
An exception for invalid intent handlers. |
| LuisActionDialog |
The dialog wrapping Luis dialog feature. |
| LuisDialog<TResult> |
A dialog specialized to handle intents and entities from LUIS. |
| LuisIntentAttribute |
Associate a LUIS intent with a dialog method. |
| LuisServiceResult |
Matches a LuisResult object with the best scored IntentRecommendation of the LuisResult and corresponding Luis service. |
| LuisTraceInfo |
The schema for the LUIS trace info |
| MessageOptions |
Optional message properties that can be sent SayAsync(IBotToUser, String, String, MessageOptions, String, CancellationToken) |
| MultipleResumeHandlerException |
The exception representing multiple resume handlers specified for the dialog stack. |
| NoResumeHandlerException |
The exception representing no resume handler specified for the dialog stack. |
| NumberPrompt<T> |
Prompts a user to enter a number. |
| OAuthPrompt |
Creates a new prompt that asks the user to sign in using the Bot Frameworks Single Sign On (SSO) service. |
| OAuthPromptSettings |
Contains settings for an OAuthPrompt. |
| ObjectPath |
Helper methods for working with dynamic json objects. |
| PersistedState |
Represents the persisted data across turns. |
| PersistedStateKeys |
These are the keys which are persisted. |
| Prompt<T> |
Defines the core behavior of prompt dialogs. |
| PromptDialog |
Dialog factory for simple prompts. |
| PromptDialog.PromptAttachment |
Prompt for an attachment |
| PromptDialog.PromptChoice<T> |
Prompt for a choice from a set of choices. |
| PromptDialog.PromptConfirm |
Prompt for a confirmation. |
| PromptDialog.PromptDouble |
Prompt for a double. |
| PromptDialog.PromptInt64 |
Prompt for a Int64 |
| PromptDialog.PromptString |
Prompt for a text string. |
| PromptException |
The root of the exception hierarchy related to prompts. |
| PromptOptions |
Contains settings to pass to a Prompt<T> when the prompt is started. |
| PromptOptions<T> |
Options for PromptDialog. |
| PromptOptionsWithSynonyms<T> |
Options with synonyms for PromptDialog. |
| PromptRecognizeChoicesOptions | |
| PromptRecognizeNumbersOptions | |
| PromptRecognizer | |
| PromptRecognizerResult<T> |
Contains the result returned by the recognition method of a Prompt<T>. |
| PromptStyler |
Styles a prompt |
| PromptValidatorContext<T> |
Contains context information for a PromptValidator<T>. |
| RecognizeEntity<T> | |
| Recognizer |
Recognizer base class. |
| RegexCase<R> |
The regex case for switch. |
| ResumptionCookie |
The resumption cookie that can be used to resume a conversation with a user. |
| ScopePath |
Defines paths for the available scopes. |
| SkillDialog |
A specialized Dialog that can wrap remote calls to a skill. |
| SkillDialogOptions |
Defines the options that will be used to execute a SkillDialog. |
| TextPrompt |
Prompts the user for text input. |
| ThisPath |
Defines path passed to the active dialog. |
| TooManyAttemptsException |
The exception representing too many attempts by the user to answer the question asked by the prompt. |
| TurnPath |
Defines path for avaiable turns. |
| UrlToken |
Allow object instances to serialized to URLs. Base64 can not be stored in URLs due to special characters. |
| WaterfallDialog |
Dialog optimized for prompting a user with a series of questions. Waterfalls accept a stack of functions which will be executed in sequence. Each waterfall step can ask a question of the user and the user's response will be passed as an argument to the next waterfall step. |
| WaterfallStepContext |
Provides context for a step in a WaterfallDialog. |
Interfaces
| IAddress |
The key that minimally and completely identifies a bot's conversation with a user on a channel. |
| IAwaitable<T> |
Explicit interface to support the compiling of async/await. |
| IBotContext |
The context for the bot. |
| IBotDataBag |
A property bag of bot data. |
| ICase<T,R> |
The interface for cases evaluated by switch. |
| IChannelCapability |
Capability for a specific channel |
| IDialog |
A IDialog is a suspendable conversational process that produces an ignored result. |
| IDialog<TResult> |
A IDialog<TResult> is a suspendable conversational process that produces a result of type |
| IDialogContext |
The context for the execution of a dialog's conversational process. |
| IDialogDependencies |
Defines Dialog Dependencies interface for enumerating child dialogs. |
| IItemIdentity |
Defines the interface for getting an items identity. |
| IPromptOptions<T> |
Options for PromptDialog. |
| IPromptRecognizeChoicesOptions | |
| IPromptRecognizeNumbersOptions | |
| IPromptRecognizer | |
| IPromptRecognizeValuesOptions | |
| ITemplate<T> |
Defines Template interface for binding data to T. |
Enums
| DialogReason |
Indicates in which a dialog-related method is being called. |
| DialogTurnStatus |
Enums the possible states of the dialogs on the stack. |
| PromptStyle |
The style of generated prompt |
Delegates
| Chain.Continuation<T,R> |
When the antecedent IDialog<TResult> has completed, execute this continuation method to construct the next IDialog<TResult>. |
| ContextualSelector<T,R> |
The contextual selector function. |
| IntentActivityHandler |
The handler for a LUIS intent. |
| IntentHandler |
The handler for a LUIS intent. |
| PromptValidator<T> |
The delegate definition for custom prompt validators. Implement this function to add custom validation to a prompt. |
| ResumeAfter<T> |
Encapsulates a method that represents the code to execute after a result is available. |
| StartAsync |
Encapsulate a method that represents the code to start a dialog. |
| WaterfallStep |
A delegate definition of a Waterfall step. This is implemented by application code. |