FormState.cs
1 //
2 // Copyright (c) Microsoft. All rights reserved.
3 // Licensed under the MIT license.
4 //
5 // Microsoft Bot Framework: http://botframework.com
6 //
7 // Bot Builder SDK GitHub:
8 // https://github.com/Microsoft/BotBuilder
9 //
10 // Copyright (c) Microsoft Corporation
11 // All rights reserved.
12 //
13 // MIT License:
14 // Permission is hereby granted, free of charge, to any person obtaining
15 // a copy of this software and associated documentation files (the
16 // "Software"), to deal in the Software without restriction, including
17 // without limitation the rights to use, copy, modify, merge, publish,
18 // distribute, sublicense, and/or sell copies of the Software, and to
19 // permit persons to whom the Software is furnished to do so, subject to
20 // the following conditions:
21 //
22 // The above copyright notice and this permission notice shall be
23 // included in all copies or substantial portions of the Software.
24 //
25 // THE SOFTWARE IS PROVIDED ""AS IS"", WITHOUT WARRANTY OF ANY KIND,
26 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
27 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
28 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
29 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
30 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
31 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
32 //
33 
34 using System;
35 using System.Collections.Generic;
36 using System.Globalization;
37 
39 
40 namespace Microsoft.Bot.Builder.FormFlow
41 {
42  [Serializable]
43  internal class FormState
44  {
45  // Last sent prompt which is used when feedback is supplied
46  public FormPrompt LastPrompt;
47 
48  // Used when navigating to reflect choices for next
49  public NextStep Next;
50 
51  // Currently executing step
52  public int Step;
53 
54  // History of executed steps
55  public Stack<int> History;
56 
57  // Current phase of each step
58  public StepPhase[] Phases;
59 
60  // Internal state of a step
61  public object StepState;
62 
63  // Field number and input
64  public List<Tuple<int, string>> FieldInputs;
65 
66  // True when we have started processing FieldInputs
67  public bool ProcessInputs;
68 
69  public FormState(int steps)
70  {
71  Phases = new StepPhase[steps];
72  Reset();
73  }
74 
75  public void Reset()
76  {
77  LastPrompt = new FormPrompt();
78  Next = null;
79  Step = 0;
80  History = new Stack<int>();
81  Phases = new StepPhase[Phases.Length];
82  StepState = null;
83  FieldInputs = null;
84  ProcessInputs = false;
85  }
86 
87  public StepPhase Phase()
88  {
89  return Phases[Step];
90  }
91 
92  public StepPhase Phase(int step)
93  {
94  return Phases[step];
95  }
96 
97  public void SetPhase(StepPhase phase)
98  {
99  Phases[Step] = phase;
100  }
101 
102  public void SetPhase(int step, StepPhase phase)
103  {
104  Phases[step] = phase;
105  }
106  }
107 }
Core namespace for FormFlow and associated infrastructure.
Definition: Attributes.cs:39
Namespace for FormFlow advanced building blocks.
Definition: Attributes.cs:672
Move to the next step that is IFieldPrompt<T>.Active(T) and uncompleted.
Root namespace for the Microsoft Bot Builder SDK.
The prompt that is returned by form prompter.
Definition: IPrompt.cs:85