ChoicePrompt Class
Definition
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.
Prompts a user to select from a list of choices.
public class ChoicePrompt : Microsoft.Bot.Builder.Dialogs.Prompt<Microsoft.Bot.Builder.Dialogs.Choices.FoundChoice>type ChoicePrompt = class
inherit Prompt<FoundChoice>Public Class ChoicePrompt
Inherits Prompt(Of FoundChoice)- Inheritance
Constructors
| ChoicePrompt(String, Dictionary<String,ChoiceFactoryOptions>, PromptValidator<FoundChoice>, String) |
Initializes a new instance of the ChoicePrompt class. |
| ChoicePrompt(String, PromptValidator<FoundChoice>, String) |
Initializes a new instance of the ChoicePrompt class. |
Properties
| ChoiceOptions |
Gets or sets additional options passed to the ChoiceFactory and used to tweak the style of choices rendered to the user. |
| DefaultLocale |
Gets or sets the default locale used to determine language-specific behavior of the prompt. |
| Id |
Gets or sets id for the dialog. (Inherited from Dialog) |
| RecognizerOptions |
Gets or sets additional options passed to the underlying RecognizeChoices(String, IList<Choice>, FindChoicesOptions) method. |
| Source |
Gets the information of the cref="SourceRange"/>. (Inherited from Dialog) |
| Style |
Gets or sets the style to use when presenting the prompt to the user. |
| TelemetryClient |
Gets or sets the IBotTelemetryClient to use for logging. (Inherited from Dialog) |
Methods
| AppendChoices(IMessageActivity, String, IList<Choice>, ListStyle, ChoiceFactoryOptions, CancellationToken) |
When overridden in a derived class, appends choices to the activity when the user is prompted for input. (Inherited from Prompt<T>) |
| BeginDialogAsync(DialogContext, Object, CancellationToken) |
Called when a prompt dialog is pushed onto the dialog stack and is being activated. (Inherited from Prompt<T>) |
| ContinueDialogAsync(DialogContext, CancellationToken) |
Called when a prompt dialog is the active dialog and the user replied with a new activity. (Inherited from Prompt<T>) |
| EndDialogAsync(ITurnContext, DialogInstance, DialogReason, CancellationToken) |
Called when the dialog is ending. (Inherited from Dialog) |
| GetVersion() |
Gets a unique string which represents the version of this dialog. If the version changes between turns the dialog system will emit a DialogChanged event. (Inherited from Dialog) |
| OnComputeId() |
Builds the compute Id for the dialog. (Inherited from Dialog) |
| OnDialogEventAsync(DialogContext, DialogEvent, CancellationToken) |
Called when an event has been raised, using |
| OnPostBubbleEventAsync(DialogContext, DialogEvent, CancellationToken) |
Called after an event was bubbled to all parents and wasn't handled. (Inherited from Dialog) |
| OnPreBubbleEventAsync(DialogContext, DialogEvent, CancellationToken) |
Called before an event is bubbled to its parent. (Inherited from Prompt<T>) |
| OnPromptAsync(ITurnContext, IDictionary<String,Object>, PromptOptions, Boolean, CancellationToken) |
Prompts the user for input. |
| OnRecognizeAsync(ITurnContext, IDictionary<String,Object>, PromptOptions, CancellationToken) |
Attempts to recognize the user's input. |
| RegisterSourceLocation(String, Int32) |
Registers a cref="SourceRange"/> in the provided location. (Inherited from Dialog) |
| RepromptDialogAsync(ITurnContext, DialogInstance, CancellationToken) |
Called when a prompt dialog has been requested to re-prompt the user for input. (Inherited from Prompt<T>) |
| ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken) |
Called when a prompt dialog resumes being the active dialog on the dialog stack, such as when the previous active dialog on the stack completes. (Inherited from Prompt<T>) |
Extension Methods
| RunAsync(Dialog, ITurnContext, IStatePropertyAccessor<DialogState>, CancellationToken) |
Creates a dialog stack and starts a dialog, pushing it onto the stack. |