Microsoft.Bot.Builder.FormFlow.ValidateResult Class Reference

Encapsulates the result of a ValidateAsyncDelegate<T> More...

Public Attributes

IEnumerable< ChoiceChoices
 Choices for clarifying response. More...
 
string Feedback
 Feedback to provide back to the user on the input. More...
 
FormPrompt FeedbackCard
 Fully specified feedback card. More...
 
bool IsValid
 True if value is a valid response. More...
 
object Value
 Value to put in the field if result is valid. More...
 

Detailed Description

Encapsulates the result of a ValidateAsyncDelegate<T>

If IsValid is true, then the field will be set to Value. Otherwise if Choices is non-null they will be used to select a clarifying value. if FeedbackCard is non-null the resulting card will be displayed. Otherwise the Feedback string will be shown to provide feedback on the value.

Definition at line 79 of file IFormDialog.cs.

Member Data Documentation

IEnumerable<Choice> Microsoft.Bot.Builder.FormFlow.ValidateResult.Choices

Choices for clarifying response.

Definition at line 101 of file IFormDialog.cs.

string Microsoft.Bot.Builder.FormFlow.ValidateResult.Feedback

Feedback to provide back to the user on the input.

Definition at line 82 of file IFormDialog.cs.

FormPrompt Microsoft.Bot.Builder.FormFlow.ValidateResult.FeedbackCard

Fully specified feedback card.

Definition at line 87 of file IFormDialog.cs.

bool Microsoft.Bot.Builder.FormFlow.ValidateResult.IsValid

True if value is a valid response.

Definition at line 90 of file IFormDialog.cs.

object Microsoft.Bot.Builder.FormFlow.ValidateResult.Value

Value to put in the field if result is valid.

This provides an opportunity for validation to compute the final value.

Definition at line 96 of file IFormDialog.cs.


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