IForm.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 
36 using System.Collections;
37 using System.Collections.Generic;
38 using System.Resources;
39 using System.Threading.Tasks;
40 
41 namespace Microsoft.Bot.Builder.FormFlow
42 {
43  #region Documentation
44  #endregion
47  public abstract class IForm<T>
48  where T : class
49  {
53  public abstract IFields<T> Fields { get; }
54 
55  #region Documentation
56  #endregion
59  public abstract void SaveResources(IResourceWriter writer);
60 
61  #region Documentation
62  #endregion
70  public abstract void Localize(IDictionaryEnumerator reader, out IEnumerable<string> missing, out IEnumerable<string> extra);
71 
72  // Internals
73  internal abstract ILocalizer Resources { get; }
74  internal abstract FormConfiguration Configuration { get; }
75  internal abstract IReadOnlyList<IStep<T>> Steps { get; }
76  internal abstract OnCompletionAsyncDelegate<T> Completion { get; }
77  internal abstract Task<FormPrompt> Prompt(IDialogContext context, FormPrompt prompt, T state, IField<T> field);
78  }
79 }
Core namespace for FormFlow and associated infrastructure.
Definition: Attributes.cs:39
The context for the execution of a dialog&#39;s conversational process.
Dictionary of all fields indexed by name.
Definition: Field.cs:785
Interface to track all of the fields in a form.
Definition: IField.cs:427
Interface for all the information about a specific field.
Definition: IField.cs:404
Namespace for FormFlow advanced building blocks.
Definition: Attributes.cs:672
Form definition interface.
Definition: IForm.cs:47
Interface for localizing string resources.
Definition: ILocalizer.cs:44
Core namespace for Dialogs and associated infrastructure.
Root namespace for the Microsoft Bot Builder SDK.
The prompt that is returned by form prompter.
Definition: IPrompt.cs:85