Microsoft.Bot.Builder.Dialogs.PromptDialog.PromptChoice< T > Class Template Referenceabstract

Prompt for a choice from a set of choices. More...

Inheritance diagram for Microsoft.Bot.Builder.Dialogs.PromptDialog.PromptChoice< T >:

Public Member Functions

 PromptChoice (IEnumerable< T > options, string prompt, string retry, int attempts, PromptStyle promptStyle=PromptStyle.Auto, IEnumerable< string > descriptions=null)
 Constructor for a prompt choice dialog. More...
 
 PromptChoice (PromptOptions< T > promptOptions)
 Constructs a choice dialog. More...
 
virtual Tuple< bool, int > ScoreMatch (T option, string input)
 

Protected Member Functions

virtual IMessageActivity MakePrompt (IDialogContext context, string prompt, IReadOnlyList< U > options=null, IReadOnlyList< string > descriptions=null)
 
virtual async Task MessageReceivedAsync (IDialogContext context, IAwaitable< IMessageActivity > message)
 
override bool TryParse (IMessageActivity message, out T result)
 
abstract bool TryParse (IMessageActivity message, out T result)
 

Protected Attributes

readonly PromptOptions< U > promptOptions
 

Detailed Description

Prompt for a choice from a set of choices.

Normally used through PromptDialog.Choice<T>(IDialogContext, ResumeAfter<T>, IEnumerable<T>, string, string, int, PromptStyle, IEnumerable<string>).

Definition at line 548 of file PromptDialog.cs.

Constructor & Destructor Documentation

Microsoft.Bot.Builder.Dialogs.PromptDialog.PromptChoice< T >.PromptChoice ( IEnumerable< T >  options,
string  prompt,
string  retry,
int  attempts,
PromptStyle  promptStyle = PromptStyle.Auto,
IEnumerable< string >  descriptions = null 
)
inline

Constructor for a prompt choice dialog.

Parameters
optionsEnumerable of the options to choose from.
promptThe prompt.
retryWhat to display on retry.
attemptsMaximum number of attempts.
promptStyleStyle of the prompt PromptStyle
descriptionsDescriptions to show for each option.

Definition at line 557 of file PromptDialog.cs.

Constructs a choice dialog.

Parameters
promptOptionsThe prompt options

Definition at line 566 of file PromptDialog.cs.

Member Function Documentation

virtual IMessageActivity Microsoft.Bot.Builder.Dialogs.Internals.Prompt< T, U >.MakePrompt ( IDialogContext  context,
string  prompt,
IReadOnlyList< U >  options = null,
IReadOnlyList< string >  descriptions = null 
)
inlineprotectedvirtualinherited

Definition at line 770 of file PromptDialog.cs.

virtual async Task Microsoft.Bot.Builder.Dialogs.Internals.Prompt< T, U >.MessageReceivedAsync ( IDialogContext  context,
IAwaitable< IMessageActivity message 
)
inlineprotectedvirtualinherited

Definition at line 744 of file PromptDialog.cs.

virtual Tuple<bool, int> Microsoft.Bot.Builder.Dialogs.PromptDialog.PromptChoice< T >.ScoreMatch ( option,
string  input 
)
inlinevirtual

Definition at line 572 of file PromptDialog.cs.

override bool Microsoft.Bot.Builder.Dialogs.PromptDialog.PromptChoice< T >.TryParse ( IMessageActivity  message,
out T  result 
)
inlineprotected

Definition at line 583 of file PromptDialog.cs.

abstract bool Microsoft.Bot.Builder.Dialogs.Internals.Prompt< T, U >.TryParse ( IMessageActivity  message,
out T  result 
)
protectedpure virtualinherited

Member Data Documentation

readonly PromptOptions<U> Microsoft.Bot.Builder.Dialogs.Internals.Prompt< T, U >.promptOptions
protectedinherited

Definition at line 730 of file PromptDialog.cs.


The documentation for this class was generated from the following file: