Microsoft.Bot.Builder.FormFlow.Advanced.TermMatch Class Reference

Describe a possible match in the user input. More...

Public Member Functions

 TermMatch (int start, int length, double confidence, object value)
 Construct a match. More...
 
bool Covers (TermMatch match)
 Check to see if this completely covers match. More...
 
override bool Equals (object obj)
 
override int GetHashCode ()
 
bool Overlaps (TermMatch match)
 Check to see if this overlaps with match in input. More...
 
bool Same (TermMatch match)
 Check to see if this covers the same span as match. More...
 
override string ToString ()
 

Static Public Member Functions

static bool operator!= (TermMatch m1, TermMatch m2)
 
static bool operator== (TermMatch m1, TermMatch m2)
 

Public Attributes

readonly double Confidence
 Confidence of match, 0-1.0. More...
 
readonly int Length
 Length of match in input string. More...
 
readonly int Start
 Start of match in input string. More...
 
readonly object Value
 Underlying C# value. More...
 

Properties

int End [get]
 End of match in input string. More...
 

Detailed Description

Describe a possible match in the user input.

Definition at line 53 of file IRecognize.cs.

Constructor & Destructor Documentation

Microsoft.Bot.Builder.FormFlow.Advanced.TermMatch.TermMatch ( int  start,
int  length,
double  confidence,
object  value 
)
inline

Construct a match.

Parameters
startStart of match in input string.
lengthLength of match in input string.
confidenceConfidence of match, 0-1.0.
valueThe underlying C# value for the match.

Definition at line 62 of file IRecognize.cs.

Member Function Documentation

bool Microsoft.Bot.Builder.FormFlow.Advanced.TermMatch.Covers ( TermMatch  match)
inline

Check to see if this completely covers match.

Parameters
matchTermMatch to compare.
Returns
True if this covers all of match.

Definition at line 110 of file IRecognize.cs.

override bool Microsoft.Bot.Builder.FormFlow.Advanced.TermMatch.Equals ( object  obj)
inline

Definition at line 134 of file IRecognize.cs.

override int Microsoft.Bot.Builder.FormFlow.Advanced.TermMatch.GetHashCode ( )
inline

Definition at line 149 of file IRecognize.cs.

static bool Microsoft.Bot.Builder.FormFlow.Advanced.TermMatch.operator!= ( TermMatch  m1,
TermMatch  m2 
)
inlinestatic

Definition at line 144 of file IRecognize.cs.

static bool Microsoft.Bot.Builder.FormFlow.Advanced.TermMatch.operator== ( TermMatch  m1,
TermMatch  m2 
)
inlinestatic

Definition at line 139 of file IRecognize.cs.

bool Microsoft.Bot.Builder.FormFlow.Advanced.TermMatch.Overlaps ( TermMatch  match)
inline

Check to see if this overlaps with match in input.

Parameters
matchTermMatch to compare.
Returns
True if the matches overlap in the input.

Definition at line 120 of file IRecognize.cs.

bool Microsoft.Bot.Builder.FormFlow.Advanced.TermMatch.Same ( TermMatch  match)
inline

Check to see if this covers the same span as match.

Parameters
matchTermMatch to compare.
Returns
True if both cover the same span.

Definition at line 100 of file IRecognize.cs.

override string Microsoft.Bot.Builder.FormFlow.Advanced.TermMatch.ToString ( )
inline

Definition at line 129 of file IRecognize.cs.

Member Data Documentation

readonly double Microsoft.Bot.Builder.FormFlow.Advanced.TermMatch.Confidence

Confidence of match, 0-1.0.

Definition at line 88 of file IRecognize.cs.

readonly int Microsoft.Bot.Builder.FormFlow.Advanced.TermMatch.Length

Length of match in input string.

Definition at line 83 of file IRecognize.cs.

readonly int Microsoft.Bot.Builder.FormFlow.Advanced.TermMatch.Start

Start of match in input string.

Definition at line 73 of file IRecognize.cs.

readonly object Microsoft.Bot.Builder.FormFlow.Advanced.TermMatch.Value

Underlying C# value.

Definition at line 93 of file IRecognize.cs.

Property Documentation

int Microsoft.Bot.Builder.FormFlow.Advanced.TermMatch.End
get

End of match in input string.

Definition at line 78 of file IRecognize.cs.


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