Microsoft.Bot.Builder.Dialogs.PromptDialog.PromptString Class Referenceabstract

Prompt for a text string. More...

Inheritance diagram for Microsoft.Bot.Builder.Dialogs.PromptDialog.PromptString:

Public Member Functions

 PromptString (string prompt, string retry, int attempts)
 Constructor for a prompt string dialog. More...
 PromptString (PromptOptions< string > promptOptions)
 Constructor for a prompt string dialog. More...

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 string result)
abstract bool TryParse (IMessageActivity message, out T result)

Protected Attributes

readonly PromptOptions< U > promptOptions


string DefaultRetry [get]

Detailed Description

Prompt for a text string.

Normally used through PromptDialog.Text(IDialogContext, ResumeAfter<string>, string, string, int).

Definition at line 383 of file PromptDialog.cs.

Constructor & Destructor Documentation

Microsoft.Bot.Builder.Dialogs.PromptDialog.PromptString.PromptString ( string  prompt,
string  retry,
int  attempts 

Constructor for a prompt string dialog.

promptThe prompt.
retryWhat to display on retry.
attemptsMaximum number of attempts.

Definition at line 389 of file PromptDialog.cs.

Microsoft.Bot.Builder.Dialogs.PromptDialog.PromptString.PromptString ( PromptOptions< string >  promptOptions)

Constructor for a prompt string dialog.

promptOptionsTHe prompt options.

Definition at line 394 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 

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 

Definition at line 744 of file PromptDialog.cs.

override bool Microsoft.Bot.Builder.Dialogs.PromptDialog.PromptString.TryParse ( IMessageActivity  message,
out string  result 

Definition at line 400 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

Definition at line 730 of file PromptDialog.cs.

Property Documentation

string Microsoft.Bot.Builder.Dialogs.PromptDialog.PromptString.DefaultRetry

Definition at line 415 of file PromptDialog.cs.

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