Microsoft.Bot.Builder.FormFlow.Advanced.IRecognize< T > Interface Template Reference

Interface for recognizers that look for matches in user input. More...

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

Public Member Functions

string Help (T state, object defaultValue=null)
 Return the help string describing what are valid inputs to the recognizer. More...
 
IEnumerable< TermMatchMatches (string input, object defaultValue=null)
 Return the matches found in the input. More...
 
object[] PromptArgs ()
 Return the arguments to pass to the prompt. More...
 
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

Interface for recognizers that look for matches in user input.

Template Parameters
TUnderlying form state.

Definition at line 159 of file IRecognize.cs.

Member Function Documentation

IEnumerable<TermMatch> Microsoft.Bot.Builder.FormFlow.Advanced.IRecognize< T >.Matches ( string  input,
object  defaultValue = null 
)

Return the matches found in the input.

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

Implemented in Microsoft.Bot.Builder.FormFlow.Advanced.RecognizePrimitive< T >, and Microsoft.Bot.Builder.FormFlow.Advanced.RecognizeEnumeration< T >.

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.

Implemented in Microsoft.Bot.Builder.FormFlow.Advanced.RecognizeDouble< T >, Microsoft.Bot.Builder.FormFlow.Advanced.RecognizeNumber< T >, Microsoft.Bot.Builder.FormFlow.Advanced.RecognizePrimitive< T >, and Microsoft.Bot.Builder.FormFlow.Advanced.RecognizeEnumeration< T >.

Return all possible value descriptions in order to support enumeration.

Returns
All possible value descriptions.

Implemented in Microsoft.Bot.Builder.FormFlow.Advanced.RecognizeBool< T >, Microsoft.Bot.Builder.FormFlow.Advanced.RecognizePrimitive< T >, and Microsoft.Bot.Builder.FormFlow.Advanced.RecognizeEnumeration< T >.

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

Return all possible values or null if a primitive type.

Returns
All possible values.

Implemented in Microsoft.Bot.Builder.FormFlow.Advanced.RecognizePrimitive< T >, and Microsoft.Bot.Builder.FormFlow.Advanced.RecognizeEnumeration< T >.


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