IDialogTask.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 
35 using Microsoft.Bot.Connector;
36 using System;
37 using System.Collections.Generic;
38 using System.Threading;
39 using System.Threading.Tasks;
40 
41 namespace Microsoft.Bot.Builder.Dialogs.Internals
42 {
46  public interface IDialogStack
47  {
51  IReadOnlyList<Delegate> Frames { get; }
52 
57  void Wait<R>(ResumeAfter<R> resume);
58 
65  void Call<R>(IDialog<R> child, ResumeAfter<R> resume);
66 
72  void Post<E>(E @event, ResumeAfter<E> resume);
73 
84  Task Forward<R, T>(IDialog<R> child, ResumeAfter<R> resume, T item, CancellationToken token);
85 
91  void Done<R>(R value);
92 
97  void Fail(Exception error);
98 
102  void Reset();
103  }
104 
105  public interface IDialogTask : IDialogStack, IEventLoop, IEventProducer<IActivity>
106  {
107  }
108 
109  public static partial class Extensions
110  {
121  public static async Task InterruptAsync<T, R>(this IDialogTask task, IDialog<T> dialog, R item, CancellationToken token)
122  {
123  await task.Forward(dialog.Void<T, R>(), null, item, token);
124  await task.PollAsync(token);
125  }
126  }
127 }
Namespace for the Microsoft Bot Connector SDK.
The stack of dialogs in the conversational process.
Definition: IDialogTask.cs:46
Root namespace for the Microsoft Bot Builder SDK.