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

Prompt for a confirmation. More...

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

Public Member Functions

 PromptConfirm (string prompt, string retry, int attempts, PromptStyle promptStyle=PromptStyle.Auto)
 Constructor for a prompt confirmation dialog. More...
 
 PromptConfirm (PromptOptions< string > promptOptions)
 Constructor for a prompt confirmation dialog. More...
 

Public Attributes

const int No = 1
 Index of no descriptions. More...
 
const int Yes = 0
 Index of yes descriptions. 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 bool result)
 
abstract bool TryParse (IMessageActivity message, out T result)
 

Protected Attributes

readonly PromptOptions< U > promptOptions
 

Properties

string DefaultRetry [get]
 
static string[] Options [get, set]
 The yes, no options for confirmation prompt More...
 
static string[][] Patterns = { Resources.MatchYes.SplitList().First(), Resources.MatchNo.SplitList().First() } [get, set]
 The patterns for matching yes/no responses in the confirmation prompt. More...
 

Detailed Description

Prompt for a confirmation.

Normally used through PromptDialog.Confirm(IDialogContext, ResumeAfter<bool>, string, string, int, PromptStyle).

Definition at line 426 of file PromptDialog.cs.

Constructor & Destructor Documentation

Microsoft.Bot.Builder.Dialogs.PromptDialog.PromptConfirm.PromptConfirm ( string  prompt,
string  retry,
int  attempts,
PromptStyle  promptStyle = PromptStyle.Auto 
)
inline

Constructor for a prompt confirmation dialog.

Parameters
promptThe prompt.
retryWhat to display on retry.
attemptsMaximum number of attempts.
promptStyleStyle of the prompt PromptStyle

Definition at line 453 of file PromptDialog.cs.

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

Constructor for a prompt confirmation dialog.

Parameters
promptOptionsTHe prompt options.

Definition at line 462 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.

override bool Microsoft.Bot.Builder.Dialogs.PromptDialog.PromptConfirm.TryParse ( IMessageActivity  message,
out bool  result 
)
inlineprotected

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

const int Microsoft.Bot.Builder.Dialogs.PromptDialog.PromptConfirm.No = 1

Index of no descriptions.

Definition at line 436 of file PromptDialog.cs.

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

Definition at line 730 of file PromptDialog.cs.

const int Microsoft.Bot.Builder.Dialogs.PromptDialog.PromptConfirm.Yes = 0

Index of yes descriptions.

Definition at line 431 of file PromptDialog.cs.

Property Documentation

string Microsoft.Bot.Builder.Dialogs.PromptDialog.PromptConfirm.DefaultRetry
get

Definition at line 491 of file PromptDialog.cs.

string [] Microsoft.Bot.Builder.Dialogs.PromptDialog.PromptConfirm.Options
staticgetset

The yes, no options for confirmation prompt

Definition at line 441 of file PromptDialog.cs.

string [][] Microsoft.Bot.Builder.Dialogs.PromptDialog.PromptConfirm.Patterns = { Resources.MatchYes.SplitList().First(), Resources.MatchNo.SplitList().First() }
staticgetset

The patterns for matching yes/no responses in the confirmation prompt.

Definition at line 446 of file PromptDialog.cs.


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