Microsoft.Bot.Builder.Dialogs Namespace Reference

Core namespace for Dialogs and associated infrastructure. More...

Namespaces

namespace  Internals
 Namespace for internal Dialogs machinery that is not useful for most developers and may change in the future.
 

Classes

class  Address
 The key that minimally and completely identifies a bot's conversation with a user on a channel. More...
 
class  Awaitable
 
class  AwaitableFromItem
 Creates a IAwaitable<T> from item passed to constructor. More...
 
class  Case
 The default implementation of ICase<T, R>. More...
 
class  Chain
 A fluent, chainable interface for IDialogs. More...
 
class  ChannelCapability
 
class  CommandDialog
 Dialog that dispatches based on a regex matching input. More...
 
class  Conversation
 The top level composition root for the SDK. More...
 
class  ConversationAddressComparer
 Compare two Address instances for equality, excluding the user information. More...
 
class  DefaultCase
 The default case for switch. ICase<T, R> More...
 
class  DeleteProfileScorable
 
class  DetectChannelCapability
 
class  DialogStackException
 The root of the exception hierarchy related to Internals.IDialogStack . More...
 
class  DispatchDialog
 A dialog specialized to dispatch an IScorable. More...
 
class  Extensions
 Helper methods. More...
 
interface  IAddress
 The key that minimally and completely identifies a bot's conversation with a user on a channel. More...
 
interface  IAwaitable
 Explicit interface to support the compiling of async/await. More...
 
interface  IBotContext
 The context for the bot. More...
 
interface  IBotDataBag
 A property bag of bot data. More...
 
interface  ICase
 The interface for cases evaluated by switch. More...
 
interface  IChannelCapability
 Capability for a specific channel More...
 
interface  IDetectChannelCapability
 Channel capability detector. More...
 
interface  IDialog
 A IDialog<TResult> is a suspendable conversational process that produces a result of type TResult . More...
 
interface  IDialogContext
 The context for the execution of a dialog's conversational process. More...
 
class  InvalidIntentHandlerException
 An exception for invalid intent handlers. More...
 
class  LuisActionDialog
 The dialog wrapping Luis dialog feature. More...
 
class  LuisDialog
 A dialog specialized to handle intents and entities from LUIS. More...
 
class  LuisIntentAttribute
 Associate a LUIS intent with a dialog method. More...
 
class  LuisServiceResult
 Matches a LuisResult object with the best scored IntentRecommendation of the LuisResult and corresponding Luis service. More...
 
class  MultipleResumeHandlerException
 The exception representing multiple resume handlers specified for the dialog stack. More...
 
class  NoResumeHandlerException
 The exception representing no resume handler specified for the dialog stack. More...
 
class  PromptDialog
 Dialog factory for simple prompts. More...
 
class  PromptException
 The root of the exception hierarchy related to prompts. More...
 
class  PromptOptions
 Options for PromptDialog. More...
 
class  PromptStyler
 Styles a prompt More...
 
class  RegexCase
 The regex case for switch. More...
 
class  ResumptionCookie
 The resumption cookie that can be used to resume a conversation with a user. More...
 
class  TooManyAttemptsException
 The exception representing too many attempts by the user to answer the question asked by the prompt. More...
 
class  UrlToken
 Allow object instances to serialized to URLs. Base64 can not be stored in URLs due to special characters. More...
 

Enumerations

enum  PromptStyle {
  PromptStyle.Auto, PromptStyle.Keyboard, PromptStyle.AutoText, PromptStyle.Inline,
  PromptStyle.PerLine, PromptStyle.None
}
 The style of generated prompt More...
 

Functions

delegate R ContextualSelector< in T, R > (IBotContext context, T item)
 The contextual selector function. More...
 
delegate Task IntentActivityHandler (IDialogContext context, IAwaitable< IMessageActivity > message, LuisResult luisResult)
 The handler for a LUIS intent. More...
 
delegate Task IntentHandler (IDialogContext context, LuisResult luisResult)
 The handler for a LUIS intent. More...
 
delegate Task ResumeAfter< in T > (IDialogContext context, IAwaitable< T > result)
 Encapsulates a method that represents the code to execute after a result is available. More...
 
delegate Task StartAsync (IDialogContext context)
 Encapsulate a method that represents the code to start a dialog. More...
 

Detailed Description

Core namespace for Dialogs and associated infrastructure.

This is one of the core namespaces you should include in your code.

Enumeration Type Documentation

The style of generated prompt

Enumerator
Auto 

Generate buttons for choices and let connector generate the right style based on channel capabilities

Keyboard 

Generate keyboard card for choices that will be mapped to a HeroCard or a keyboard, e.g. Facebook quick replies

Make sure to use MapToChannelData_BotToUser with KeyboardCardMapper when you use this option

AutoText 

Show choices as Text.

The prompt decides if it should generate the text inline or perline based on number of choices.

Inline 

Show choices on the same line.

PerLine 

Show choices with one per line.

None 

Do not show possible choices in the prompt

Definition at line 49 of file PromptDialog.cs.

Function Documentation

delegate R Microsoft.Bot.Builder.Dialogs.ContextualSelector< in T, R > ( IBotContext  context,
item 
)

The contextual selector function.

Template Parameters
TThe type of value passed to selector.
RThe returned type of the selector.
Parameters
contextIBotContext passed to selector.
itemThe value passed to selector.
Returns
The value returned by selector.
delegate Task Microsoft.Bot.Builder.Dialogs.IntentActivityHandler ( IDialogContext  context,
IAwaitable< IMessageActivity message,
LuisResult  luisResult 
)

The handler for a LUIS intent.

Parameters
contextThe dialog context.
messageThe dialog message.
luisResultThe LUIS result.
Returns
A task representing the completion of the intent processing.
delegate Task Microsoft.Bot.Builder.Dialogs.IntentHandler ( IDialogContext  context,
LuisResult  luisResult 
)

The handler for a LUIS intent.

Parameters
contextThe dialog context.
luisResultThe LUIS result.
Returns
A task representing the completion of the intent processing.
delegate Task Microsoft.Bot.Builder.Dialogs.ResumeAfter< in T > ( IDialogContext  context,
IAwaitable< T >  result 
)

Encapsulates a method that represents the code to execute after a result is available.

The result is often a message from the user.

Template Parameters
TThe type of the result.
Parameters
contextThe dialog context.
resultThe result.
Returns
A task that represents the code that will resume after the result is available.
delegate Task Microsoft.Bot.Builder.Dialogs.StartAsync ( IDialogContext  context)

Encapsulate a method that represents the code to start a dialog.

Parameters
contextThe dialog context.
Returns
A task that represents the start code for a dialog.