Microsoft.Bot.Builder.Dialogs.PromptOptions< T > Class Template Reference

Options for PromptDialog. More...

Public Member Functions

 PromptOptions (string prompt, string retry=null, string tooManyAttempts=null, IReadOnlyList< T > options=null, int attempts=3, PromptStyler promptStyler=null, IReadOnlyList< string > descriptions=null)
 Constructs the prompt options. More...
 

Public Attributes

readonly IReadOnlyList< string > Descriptions
 The description of each possible option. More...
 
readonly IReadOnlyList< T > Options
 The choices to be returned when selected. More...
 
readonly string Prompt
 The prompt. More...
 
readonly PromptStyler PromptStyler
 Styler of the prompt Dialogs.PromptStyler. More...
 
readonly string Retry
 What to display on retry. More...
 
readonly string TooManyAttempts
 What to display when user didn't say a valid response after Attempts. More...
 

Properties

int Attempts [get, set]
 Maximum number of attempts. More...
 
string DefaultRetry [get, set]
 Default retry prompt that is used if Retry is null. More...
 
string DefaultTooManyAttempts [get]
 Default TooManyAttempts string that is used if TooManyAttempts is null. More...
 

Detailed Description

Options for PromptDialog.

Template Parameters
TThe type of the options.

Definition at line 93 of file PromptDialog.cs.

Constructor & Destructor Documentation

Microsoft.Bot.Builder.Dialogs.PromptOptions< T >.PromptOptions ( string  prompt,
string  retry = null,
string  tooManyAttempts = null,
IReadOnlyList< T >  options = null,
int  attempts = 3,
PromptStyler  promptStyler = null,
IReadOnlyList< string >  descriptions = null 
)
inline

Constructs the prompt options.

Parameters
promptThe prompt.
retryWhat to display on retry.
tooManyAttemptsWhat to display when user didn't say a valid response after Attempts.
optionsThe prompt choice values.
attemptsMaximum number of attempts.
promptStylerThe prompt styler.
descriptionsDescriptions for each prompt.

Definition at line 157 of file PromptDialog.cs.

Member Data Documentation

readonly IReadOnlyList<string> Microsoft.Bot.Builder.Dialogs.PromptOptions< T >.Descriptions

The description of each possible option.

If this is null, then the descriptions will be the options converted to strings. Otherwise this should have the same number of values as Options and it contains the string to describe the value being selected.

Definition at line 117 of file PromptDialog.cs.

readonly IReadOnlyList<T> Microsoft.Bot.Builder.Dialogs.PromptOptions< T >.Options

The choices to be returned when selected.

Definition at line 108 of file PromptDialog.cs.

The prompt.

Definition at line 98 of file PromptDialog.cs.

Styler of the prompt Dialogs.PromptStyler.

Definition at line 132 of file PromptDialog.cs.

readonly string Microsoft.Bot.Builder.Dialogs.PromptOptions< T >.Retry

What to display on retry.

Definition at line 103 of file PromptDialog.cs.

readonly string Microsoft.Bot.Builder.Dialogs.PromptOptions< T >.TooManyAttempts

What to display when user didn't say a valid response after Attempts.

Definition at line 122 of file PromptDialog.cs.

Property Documentation

Maximum number of attempts.

Definition at line 127 of file PromptDialog.cs.

string Microsoft.Bot.Builder.Dialogs.PromptOptions< T >.DefaultRetry
getset

Default retry prompt that is used if Retry is null.

Definition at line 137 of file PromptDialog.cs.

string Microsoft.Bot.Builder.Dialogs.PromptOptions< T >.DefaultTooManyAttempts
getprotected

Default TooManyAttempts string that is used if TooManyAttempts is null.

Definition at line 143 of file PromptDialog.cs.


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