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

Recognizer for enumerated values. More...

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

Public Member Functions

 RecognizeEnumeration (IField< T > field)
 Constructor based on IField<T>. More...
 
delegate DescribeAttribute DescriptionDelegate (object value)
 Delegate for mapping from a C# value to it's description. More...
 
string Help (T state, object defaultValue)
 Return the help string describing what are valid inputs to the recognizer. More...
 
IEnumerable< TermMatchMatches (string input, object defaultValue)
 Return the matches found in the input. More...
 
object[] PromptArgs ()
 Return the arguments to pass to the prompt. More...
 
delegate IEnumerable< string > TermsDelegate (object value)
 Delegate to return the terms to match on for a C# value. More...
 
override string ToString ()
 
IEnumerable< string > ValidInputs (object value)
 Return valid inputs to describe a particular value. More...
 
DescribeAttribute ValueDescription (object value)
 Return the description of a specific value. More...
 
IEnumerable< DescribeAttributeValueDescriptions ()
 Return all possible value descriptions in order to support enumeration. More...
 
IEnumerable< object > Values ()
 Return all possible values or null if a primitive type. More...
 

Detailed Description

Recognizer for enumerated values.

Type Constraints
T :class 

Definition at line 48 of file FormFlow/Recognize.cs.

Constructor & Destructor Documentation

Constructor based on IField<T>.

Parameters
fieldField with enumerated values.

Definition at line 69 of file FormFlow/Recognize.cs.

Member Function Documentation

delegate DescribeAttribute Microsoft.Bot.Builder.FormFlow.Advanced.RecognizeEnumeration< T >.DescriptionDelegate ( object  value)

Delegate for mapping from a C# value to it's description.

Parameters
valueC# value to get description for.
Returns
Description of C# value.
string Microsoft.Bot.Builder.FormFlow.Advanced.RecognizeEnumeration< T >.Help ( state,
object  defaultValue 
)
inline

Return the help string describing what are valid inputs to the recognizer.

Returns
Help on what the recognizer accepts.

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

Definition at line 112 of file FormFlow/Recognize.cs.

IEnumerable<TermMatch> Microsoft.Bot.Builder.FormFlow.Advanced.RecognizeEnumeration< T >.Matches ( string  input,
object  defaultValue 
)
inline

Return the matches found in the input.

Parameters
inputThe input string being matched.
defaultValueThe default value or null if none.
Returns
Match records.

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

Definition at line 143 of file FormFlow/Recognize.cs.

Return the arguments to pass to the prompt.

remarks>For example a numeric recognizer might pass min and max values.

Returns
An array of arguments.

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

Definition at line 87 of file FormFlow/Recognize.cs.

delegate IEnumerable<string> Microsoft.Bot.Builder.FormFlow.Advanced.RecognizeEnumeration< T >.TermsDelegate ( object  value)

Delegate to return the terms to match on for a C# value.

Parameters
valueC# value to get terms for.
Returns
Enumeration of regular expressions to match on for value.
override string Microsoft.Bot.Builder.FormFlow.Advanced.RecognizeEnumeration< T >.ToString ( )
inline

Definition at line 180 of file FormFlow/Recognize.cs.

IEnumerable<string> Microsoft.Bot.Builder.FormFlow.Advanced.RecognizeEnumeration< T >.ValidInputs ( object  value)
inline

Return valid inputs to describe a particular value.

Parameters
valueValue being checked.
Returns
Valid inputs for describing value.

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

Definition at line 107 of file FormFlow/Recognize.cs.

Return the description of a specific value.

Parameters
valueValue to get description of.
Returns
Description of the value.

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

Definition at line 102 of file FormFlow/Recognize.cs.

Return all possible value descriptions in order to support enumeration.

Returns
All possible value descriptions.

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

Definition at line 97 of file FormFlow/Recognize.cs.

IEnumerable<object> Microsoft.Bot.Builder.FormFlow.Advanced.RecognizeEnumeration< T >.Values ( )
inline

Return all possible values or null if a primitive type.

Returns
All possible values.

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

Definition at line 92 of file FormFlow/Recognize.cs.


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