Microsoft.Bot.Builder.FormFlow.Advanced.Prompter< T > Class Template Reference

A prompt and recognizer packaged together. More...

Inheritance diagram for Microsoft.Bot.Builder.FormFlow.Advanced.Prompter< T >:

Public Member Functions

 Prompter (TemplateBaseAttribute annotation, IForm< T > form, IRecognize< T > recognizer, IFields< T > fields=null)
 Construct a prompter. More...
 
FormPrompt Prompt (T state, IField< T > field, params object[] args)
 Return prompt to send to user. More...
 

Static Public Member Functions

static bool ValidatePattern (IForm< T > form, string pattern, IField< T > field, int argLimit=0)
 Validate pattern by ensuring they refer to real fields. More...
 

Properties

TemplateBaseAttribute Annotation [get]
 
IRecognize< T > Recognizer [get]
 

Detailed Description

A prompt and recognizer packaged together.

Template Parameters
TUNderlying form type.
Type Constraints
T :class 

Definition at line 330 of file IPrompt.cs.

Constructor & Destructor Documentation

Microsoft.Bot.Builder.FormFlow.Advanced.Prompter< T >.Prompter ( TemplateBaseAttribute  annotation,
IForm< T >  form,
IRecognize< T >  recognizer,
IFields< T >  fields = null 
)
inline

Construct a prompter.

Parameters
annotationAnnotation describing the Pattern Language and formatting for prompt.
formCurrent form.
recognizerRecognizer if any.
fieldsFields name lookup. (Defaults to forms.)

Definition at line 340 of file IPrompt.cs.

Member Function Documentation

FormPrompt Microsoft.Bot.Builder.FormFlow.Advanced.Prompter< T >.Prompt ( state,
IField< T >  field,
params object[]  args 
)
inline

Return prompt to send to user.

Parameters
stateCurrent form state.
fieldCurrent field being processed.
argsOptional arguments.
Returns
Message to user.

Implements Microsoft.Bot.Builder.FormFlow.Advanced.IPrompt< T >.

Definition at line 357 of file IPrompt.cs.

static bool Microsoft.Bot.Builder.FormFlow.Advanced.Prompter< T >.ValidatePattern ( IForm< T >  form,
string  pattern,
IField< T >  field,
int  argLimit = 0 
)
inlinestatic

Validate pattern by ensuring they refer to real fields.

Parameters
formThe form.
patternSpecifies the pattern.
fieldBase field for pattern.
argLimitThe number of arguments passed to the pattern.
Returns
true if it succeeds, false if it fails.

Definition at line 397 of file IPrompt.cs.

Property Documentation

Definition at line 385 of file IPrompt.cs.


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